Redis account details

To establish a connection to Redis (REmote DIctionary Server), you must add an account that defines the account details to connect with. You can define these details by creating a configuration object in the App Connect Dashboard, the Red Hat® OpenShift® web console or CLI, or the Kubernetes CLI.

Account parameters
Locating the values for the account parameters
Example

Account parameters

App Connect supports the following cloud-hosted Redis deployments:

IBM Redis V4.0: IBM Cloud Databases for Redis and IBM Compose for Redis
Amazon Web Services (AWS) Redis V5.0: Amazon ElastiCache for Redis

You can define one or more accounts for Redis.

For each account that you require, you can specify a new set of account details in any of the following ways:

If you are using the App Connect Dashboard, either complete the Account details fields in the Create configuration panel, or specify the account parameters in an accounts.yaml file before importing it into the Create configuration panel. For more information, see Accounts type.
If you are using the Red Hat OpenShift web console or CLI, or the Kubernetes CLI, specify the account parameters in an accounts.yaml file, and then use this configuration file to create a configuration object. For more information, see Creating the file for a configuration object of type Accounts.

The set of required and optional Account fields or parameters are listed in the following table.

For information about locating the values for these account parameters, see Locating the values for the account parameters.

Field	Parameter	Values	Condition	Description
Account name	name	User defined	Required	The name of a Redis account that is used in the exported flow.
Authentication type	authType	`BASIC`	Optional	The mechanism that is used for user authorization.
Host	host	User defined	Required	The host name or IP address of the Redis server.
Port	port	User defined	Required	The port number of the Redis server.
Password	password	User defined	Required	The password required for authentication.
Database number	databaseNumber	User defined	Optional	The database index of the database to connect to, typically from a range of `0` to `15`. (The index is generally shown at the end of a Redis URL.) The default is `0`.
Redis version number	redisVersionNumber	User defined	Optional	The version number of the Redis server.
TLS reject unauthorized	tlsRejectUnauthorized	`true` `false`	Required	An indication of whether the database is secured using TLS authentication and encryption. Set to `true` if an SSL or a TSL certificate is required to validate against the root certificate from the certificate authority (CA). The default is `true`. Set to `false` if certificate validation isn't required.
TLS CA	tlsCa	User defined	Required only if tlsRejectUnauthorized is set to `true`	The contents of the CA signed certificate for the cluster that hosts the database, in Base64 format. You can copy and paste the Base64-encoded contents directly from your instance.

Locating the values for the account parameters

The values for the account parameters should be available from your Redis instance. For example, if using IBM Cloud Databases for Redis, you can obtain the connection values from the Connections panel and Service Credentials panel of your service instance in IBM® Cloud.

Example

Remember: An accounts.yaml file that defines one or more accounts must always begin with the following line:
accounts:

rediscache:
  - name: "Account 1"
    credentials:
     authType: "BASIC"
     host: "abcde123-f4g5-6h7j-9876-klm54.fjfk64yrir57dcc.databases.appdomain.cloud"
     port: "31732"
     password: "1234qOlflk567r8uBheda99yzLKVtryuquiu543ythD"
     tlsRejectUnauthorized: false
    endpoint: {}