Deploy Service

Before starting service deployment, ensure the application artifact is created and uploaded to the correct path in the Artifactory (JFrog). The deployment images require this artifact; otherwise, the deployment will fail

A service can be deployed in two ways:

1. via definition.json

2. named service and version

A service is always deployed in an environment, we'll use the environment created in the previous step for this.

Let's deploy the defined service

odin deploy service --file /path/to/definition.json --provisioning /path/to/provisioning-dev.json --env ENV_NAME

A service definition file must always be accompanied by a provisioning file. Ensure that you provide the provisioning configuration for each component specified in the definition file.

The output will look something like this:

For Odin 1.x.x

If it's a new service or you have changes in your config store, use your service's config store branch to deploy service using the flag --d11-config-store-namespace

ex: odin deploy service --file definition.json --provisioning provisioning-dev.json --env ENV_NAME --d11-config-store-namespace CONFIG_BRANCH_NAME

Initiating service deployment: [email protected] in dev-2511
Validating profile@peri-dev-2511-c0548d-SNAPSHOT

Validation succeeded.

Creating images for the components...

Artifact for profile for container created successfully(25s)

All artifacts created successfully. Deploying service.

Initiating deployment in dev-2511

Adding service profile@perishable to dev-2511

Provisioning started for [profile@peri-dev-5004-c0548d-SNAPSHOT]

Service deployed successfully.

For Odin 2.0 and above

The --d11-config-store-namespace flag is now deprecated. Instead:

• You can specify this information in the env_variables object of the provisioning file for the application component.

• Use CONFIG_STORE_BRANCH as the key and set its value to the config store branch/tag you want to use.

• Example Provisioning config

[

  {
    "component_name": "<component_name>",
    "deployment_type": "<deployment_type>",
    "env_variables": {
      "CONFIG_STORE_BRANCH": "<config store branch/tag to use>"
    }
  }
]

INFO[2025-05-20 15:30:08] Generated trace ID: 24ab22d0-a6ce-4e3e-a032-c6b2a0f5f787 
INFO[2025-05-20 15:30:12] Deploying Service...                         
INFO[2025-05-20 15:34:59] 
 Service: hulk-offers version: 1.0.2 action: DEPLOY status: SUCCESSFUL
 Component: offers action: DEPLOY status: SUCCESSFUL 

Access To Deployed Components

Once a service is deployed, the respective components can be found at below URL by default unless the user has provided custom routes for their component

${COMPONENT_NAME}-${ENV_NAME}.dream11${VPC_SUFFIX}.local

For Datastores such as RDS and PostgreSQL you'll have different end points for reader and master

${COMPONENT_NAME}-reader-${ENV_NAME}.dream11${VPC_SUFFIX}.local

${COMPONENT_NAME}-master-${ENV_NAME}.dream11${VPC_SUFFIX}.local

Validating via Health Check

You can validate your service via heath check request - Health Check Request

curl --location --request GET 'http://SERVICE_NAME-{ENV_NAME}.your org details/healthcheck'