Back to Infisical

Redis

docs/documentation/platform/dynamic-secrets/redis.mdx

0.159.254.9 KB
Original Source

import DynamicSecretUsernameTemplateParamField from "/snippets/documentation/platform/dynamic-secrets/dynamic-secret-username-template-field.mdx";

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

<Steps> <Step title="Open Secret Overview Dashboard"> Open the Secret Overview dashboard and select the environment in which you would like to add a dynamic secret. </Step> <Step title="Click on the 'Add Dynamic Secret' button"> ![Add Dynamic Secret Button](../../../images/platform/dynamic-secrets/add-dynamic-secret-button.png) </Step> <Step title="Select 'Redis'"> ![Dynamic Secret Modal](../../../images/platform/dynamic-secrets/dynamic-secret-modal-redis.png) </Step> <Step title="Provide the inputs for dynamic secret parameters"> <ParamField path="Secret Name" type="string" required> Name by which you want the secret to be referenced </ParamField>
<ParamField path="Default TTL" type="string" required>
	Default time-to-live for a generated secret (it is possible to modify this value after a secret is generated)
</ParamField>

<ParamField path="Max TTL" type="string" required>
	Maximum time-to-live for a generated secret.
</ParamField>

<ParamField path="Host" type="string" required>
	The database host, this can be an IP address or a domain name as long as Infisical can reach it.
</ParamField>

<ParamField path="Port" type="number" required>
	The database port, this is the port that the Redis instance is listening on.
</ParamField>

<ParamField path="User" type="string" required>
Redis username that will be used to create new users on-demand. This is often 'default' or 'admin'.
</ParamField>

<ParamField path="Password" type="string" optional>
	Password that will be used to create dynamic secrets. This is required if your Redis instance is password protected.
</ParamField>

<ParamField path="CA(SSL)" type="string">
	A CA may be required if your DB requires it for incoming connections. This is often the case when connecting to a managed service.
</ParamField>

<ParamField path="SSL Reject Unauthorized" type="boolean" default="true">
	If enabled, the server certificate will be verified against the list of supplied CAs. Disable this option if you are using a self-signed certificate.
</ParamField>
</Step> <Step title="(Optional) Modify Redis Statements"> ![Modify Redis Statements Modal](/images/platform/dynamic-secrets/modify-redis-statement.png) <DynamicSecretUsernameTemplateParamField /> <ParamField path="Customize Redis Statement" type="string"> 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). </ParamField> </Step> <Step title="Click `Submit`"> After submitting the form, you will see a dynamic secret created in the dashboard.
<Note>
	If this step fails, you may have to add the CA certificate.
</Note>
</Step> <Step title="Generate dynamic secrets"> 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.png)
![Dynamic Secret](/images/platform/dynamic-secrets/dynamic-secret-lease-empty.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.png)

<Tip>
	Ensure that the TTL for the lease falls within the maximum TTL defined when configuring the dynamic secret.
</Tip>


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.png)
</Step> </Steps>

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 to see the expiration time of the lease or delete a lease before it's set time to live.

Renew Leases

To extend the life of the generated dynamic secret leases past its initial time to live, simply click on the Renew button as illustrated below.

<Warning> Lease renewals cannot exceed the maximum TTL set when configuring the dynamic secret </Warning>