diff --git a/docs/documentation/platform/dynamic-secrets/aws-iam.mdx b/docs/documentation/platform/dynamic-secrets/aws-iam.mdx index 6ec5b48b9..7a3976e0f 100644 --- a/docs/documentation/platform/dynamic-secrets/aws-iam.mdx +++ b/docs/documentation/platform/dynamic-secrets/aws-iam.mdx @@ -1,6 +1,6 @@ --- title: "AWS IAM" -description: "How to dynamically generate AWS IAM Users." +description: "Learn how to dynamically generate AWS IAM Users." --- The Infisical AWS IAM dynamic secret allows you to generate AWS IAM Users on demand based on configured AWS policy. diff --git a/docs/documentation/platform/dynamic-secrets/cassandra.mdx b/docs/documentation/platform/dynamic-secrets/cassandra.mdx index 78e03e011..fd46c8288 100644 --- a/docs/documentation/platform/dynamic-secrets/cassandra.mdx +++ b/docs/documentation/platform/dynamic-secrets/cassandra.mdx @@ -1,6 +1,6 @@ --- title: "Cassandra" -description: "How to dynamically generate Cassandra database users." +description: "Learn how to dynamically generate Cassandra database user credentials" --- The Infisical Cassandra dynamic secret allows you to generate Cassandra database credentials on demand based on configured role. diff --git a/docs/documentation/platform/dynamic-secrets/mssql.mdx b/docs/documentation/platform/dynamic-secrets/mssql.mdx index 8dae71399..fb666adca 100644 --- a/docs/documentation/platform/dynamic-secrets/mssql.mdx +++ b/docs/documentation/platform/dynamic-secrets/mssql.mdx @@ -1,6 +1,6 @@ --- title: "MS SQL" -description: "How to dynamically generate MS SQL database users." +description: "Learn how to dynamically generate MS SQL database user credentials." --- The Infisical MS SQL dynamic secret allows you to generate Microsoft SQL server database credentials on demand based on configured role. diff --git a/docs/documentation/platform/dynamic-secrets/mysql.mdx b/docs/documentation/platform/dynamic-secrets/mysql.mdx index c64edab63..d85f4b7bb 100644 --- a/docs/documentation/platform/dynamic-secrets/mysql.mdx +++ b/docs/documentation/platform/dynamic-secrets/mysql.mdx @@ -1,6 +1,6 @@ --- title: "MySQL" -description: "Learn how to dynamically generate MySQL Database user passwords." +description: "Learn how to dynamically generate MySQL Database user credentials." --- The Infisical MySQL dynamic secret allows you to generate MySQL Database credentials on demand based on configured role. diff --git a/docs/documentation/platform/dynamic-secrets/oracle.mdx b/docs/documentation/platform/dynamic-secrets/oracle.mdx index 05b832c4f..a6fb68913 100644 --- a/docs/documentation/platform/dynamic-secrets/oracle.mdx +++ b/docs/documentation/platform/dynamic-secrets/oracle.mdx @@ -1,6 +1,6 @@ --- title: "Oracle" -description: "Learn how to dynamically generate Oracle Database user passwords." +description: "Learn how to dynamically generate Oracle Database user credentials." --- The Infisical Oracle dynamic secret allows you to generate Oracle Database credentials on demand based on configured role. diff --git a/docs/documentation/platform/dynamic-secrets/overview.mdx b/docs/documentation/platform/dynamic-secrets/overview.mdx index 81ab42656..24c7fae4e 100644 --- a/docs/documentation/platform/dynamic-secrets/overview.mdx +++ b/docs/documentation/platform/dynamic-secrets/overview.mdx @@ -32,4 +32,5 @@ Dynamic secrets are particularly useful in environments with stringent security 2. [MySQL](./mysql) 3. [Cassandra](./cassandra) 4. [Oracle](./oracle) +6. [Redis](./redis) 5. [AWS IAM](./aws-iam) diff --git a/docs/documentation/platform/dynamic-secrets/postgresql.mdx b/docs/documentation/platform/dynamic-secrets/postgresql.mdx index 13adfc750..ebc19b011 100644 --- a/docs/documentation/platform/dynamic-secrets/postgresql.mdx +++ b/docs/documentation/platform/dynamic-secrets/postgresql.mdx @@ -1,6 +1,6 @@ --- title: "PostgreSQL" -description: "How to dynamically generate PostgreSQL database users." +description: "Learn how to dynamically generate PostgreSQL database users." --- The Infisical PostgreSQL dynamic secret allows you to generate PostgreSQL database credentials on demand based on configured role. diff --git a/docs/documentation/platform/dynamic-secrets/redis.mdx b/docs/documentation/platform/dynamic-secrets/redis.mdx new file mode 100644 index 000000000..c6bd723eb --- /dev/null +++ b/docs/documentation/platform/dynamic-secrets/redis.mdx @@ -0,0 +1,106 @@ +--- +title: "Redis" +description: "Learn how to dynamically generate Redis Database user credentials." +--- + +The Infisical Redis dynamic secret allows you to generate Redis Database credentials on demand based on configured role. + +## Prerequisite +Create a user with the required permission in your Redis instance. This user will be used to create new accounts on-demand. + + +## Set up Dynamic Secrets with Redis + + + + Open the Secret Overview dashboard and select the environment in which you would like to add a dynamic secret. + + + ![Add Dynamic Secret Button](../../../images/platform/dynamic-secrets/add-dynamic-secret-button-redis-redis.png) + + + ![Dynamic Secret Modal](../../../images/platform/dynamic-secrets/dynamic-secret-modal-redis.png) + + + + Name by which you want the secret to be referenced + + + + Default time-to-live for a generated secret (it is possible to modify this value when a secret is generate) + + + + Maximum time-to-live for a generated secret. + + + + The database host, this can be an IP address or a domain name as long as Infisical can reach it. + + + + The database port, this is the port that the Redis instance is listening on. + + + + Redis username that will be used to create new users on-demand. This is often 'default' or 'admin'. + + + + Password that will be used to create dynamic secrets. This is required if your Redis instance is password protected. + + + + A CA may be required if your DB requires it for incoming connections. This is often the case when connecting to a managed service. + + + + + If you want to provide specific privileges for the generated dynamic credentials, you can modify the Redis statement to your needs. This is useful if you want to only give access to a specific table(s). + + ![Modify Redis Statements Modal](/images/platform/dynamic-secrets/modify-redis-statement.png) + + + After submitting the form, you will see a dynamic secret created in the dashboard. + + + If this step fails, you may have to add the CA certificate. + + + + + Once you've successfully configured the dynamic secret, you're ready to generate on-demand credentials. + To do this, simply click on the 'Generate' button which appears when hovering over the dynamic secret item. + Alternatively, you can initiate the creation of a new lease by selecting 'New Lease' from the dynamic secret lease list section. + + ![Dynamic Secret](/images/platform/dynamic-secrets/dynamic-secret-generate-redis.png) + ![Dynamic Secret](/images/platform/dynamic-secrets/dynamic-secret-lease-empty-redis.png) + + When generating these secrets, it's important to specify a Time-to-Live (TTL) duration. This will dictate how long the credentials are valid for. + + ![Provision Lease](/images/platform/dynamic-secrets/provision-lease-redis.png) + + + Ensure that the TTL for the lease fall within the maximum TTL defined when configuring the dynamic secret. + + + + Once you click the `Submit` button, a new secret lease will be generated and the credentials from it will be shown to you. + + ![Provision Lease](/images/platform/dynamic-secrets/lease-values-redis.png) + + + +## Audit or Revoke Leases +Once you have created one or more leases, you will be able to access them by clicking on the respective dynamic secret item on the dashboard. +This will allow you see the expiration time of the lease or delete a lease before it's set time to live. + +![Provision Lease](/images/platform/dynamic-secrets/lease-data-redis.png) + +## Renew Leases +To extend the life of the generated dynamic secret leases past its initial time to live, simply click on the **Renew** as illustrated below. +![Provision Lease](/images/platform/dynamic-secrets/dynamic-secret-lease-renew-redis.png) + + + Lease renewals cannot exceed the maximum TTL set when configuring the dynamic secret + \ No newline at end of file diff --git a/docs/images/platform/dynamic-secrets/add-dynamic-secret-button-redis.png b/docs/images/platform/dynamic-secrets/add-dynamic-secret-button-redis.png new file mode 100644 index 000000000..537f20e73 Binary files /dev/null and b/docs/images/platform/dynamic-secrets/add-dynamic-secret-button-redis.png differ diff --git a/docs/images/platform/dynamic-secrets/dynamic-secret-generate-redis.png b/docs/images/platform/dynamic-secrets/dynamic-secret-generate-redis.png new file mode 100644 index 000000000..db7f8be35 Binary files /dev/null and b/docs/images/platform/dynamic-secrets/dynamic-secret-generate-redis.png differ diff --git a/docs/images/platform/dynamic-secrets/dynamic-secret-lease-empty-redis.png b/docs/images/platform/dynamic-secrets/dynamic-secret-lease-empty-redis.png new file mode 100644 index 000000000..a7842b298 Binary files /dev/null and b/docs/images/platform/dynamic-secrets/dynamic-secret-lease-empty-redis.png differ diff --git a/docs/images/platform/dynamic-secrets/dynamic-secret-lease-renew-redis.png b/docs/images/platform/dynamic-secrets/dynamic-secret-lease-renew-redis.png new file mode 100644 index 000000000..a2fd14d41 Binary files /dev/null and b/docs/images/platform/dynamic-secrets/dynamic-secret-lease-renew-redis.png differ diff --git a/docs/images/platform/dynamic-secrets/dynamic-secret-modal-redis.png b/docs/images/platform/dynamic-secrets/dynamic-secret-modal-redis.png new file mode 100644 index 000000000..a4835e517 Binary files /dev/null and b/docs/images/platform/dynamic-secrets/dynamic-secret-modal-redis.png differ diff --git a/docs/images/platform/dynamic-secrets/lease-data-redis.png b/docs/images/platform/dynamic-secrets/lease-data-redis.png new file mode 100644 index 000000000..f3fd51637 Binary files /dev/null and b/docs/images/platform/dynamic-secrets/lease-data-redis.png differ diff --git a/docs/images/platform/dynamic-secrets/lease-values-redis.png b/docs/images/platform/dynamic-secrets/lease-values-redis.png new file mode 100644 index 000000000..95d4a4ffd Binary files /dev/null and b/docs/images/platform/dynamic-secrets/lease-values-redis.png differ diff --git a/docs/images/platform/dynamic-secrets/modify-redis-statement.png b/docs/images/platform/dynamic-secrets/modify-redis-statement.png new file mode 100644 index 000000000..c9726f752 Binary files /dev/null and b/docs/images/platform/dynamic-secrets/modify-redis-statement.png differ diff --git a/docs/images/platform/dynamic-secrets/provision-lease-redis.png b/docs/images/platform/dynamic-secrets/provision-lease-redis.png new file mode 100644 index 000000000..f5237d058 Binary files /dev/null and b/docs/images/platform/dynamic-secrets/provision-lease-redis.png differ diff --git a/docs/mint.json b/docs/mint.json index 75368e3a8..8e4d0cdbd 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -154,6 +154,7 @@ "documentation/platform/dynamic-secrets/mssql", "documentation/platform/dynamic-secrets/oracle", "documentation/platform/dynamic-secrets/cassandra", + "documentation/platform/dynamic-secrets/redis", "documentation/platform/dynamic-secrets/aws-iam" ] },