How to use Optimus Datastore in my service?

Add Optimus Datastore to my existing deployed service

Adding Optimus datastore to the existing deployed service is similar to adding any new component to the existing deployed service. Following are the steps:

• Update your service definition & provisioning with the right details. The sample of the same can be found here:

Component Name	Files Needed	List of Exposed configs
RDS	Sample Service Definition & provisioning file for Optimus RDS	List of exposed configs for RDS can be found here.
Kafka	Sample Service Definition & provisioning file for Optimus Kafka	List of exposed configs for Kafka can be found here.

• Add the component by using odin's add component feature. One sample command of the command can be as follow. The new component details have to be passed in a file content is similar to how the component details and provisioning details of the same is passed during add_component operation. A sample file can be found here. Command for example:

odin operate service --operation add_component --name Service-A --env env-1001 --file file.json

• Once the component addition activity is completed, optimus datastore will be ready for operation via Odin. Currently available operations via Optimus datastores can be found here -

  • RDS: RDS Operations

  • Kafka: Kafka Operations

Add Optimus Datastore to my new Service

Adding Optimus datastores in a new service is no different than adding any other component to a new service and deploying the same. The following steps to be followed:

1. Define the service definition & provisioning file and include the Optimus datastore within it. A sample file can be found in the link below:

RDS	Sample Service Definition & provisioning file for Optimus RDS	List of exposed configs for RDS can be found here
Aerospike	Sample Service Definition & provisioning file for Optimus Aerospike	List of exposed configs for Aerospike can be found here
Kafka	Sample Service Definition & provisioning file for Optimus Kafka	List of exposed configs for Kafka can be found here.

1. Release the service as per the process mentioned here - Release Service. Do not forget to verify the service release by running odin list service command.

2. Deploy the service as mentioned here - Deploy Service.

3. Once the deployment is completed, along with any other components, Optimus datastore is also available for operation. Currently available operations via Optimus datastores can be found here

   • RDS: RDS Operations

   • Aerospike: Aerospike Operations

   • Kafka: Kafka Operations