Naming Conventions

Shippable uses a default naming convention for its deployment in Kubernetes and the reference for it can be found from here.

Deploy Method Default Naming Convention
blueGreen
  • deploymentName : deployJobName-manifestJobName-buildNumber
    upgrade
    • deploymentName : deployJobName-manifestJobName
      replace
      • deploymentName : deployJobName-manifestJobName

        Managed

        Shippable allows overriding the default naming convention of an Kubernetes deployment name, that was created by running a deploy job. deployName can be used in order to achieve this.

        jobs:
          - name: <job name>
            type: deploy
            steps:
              - IN: <manifest>                        #required
                deployName: <custom name>
              - IN: <cluster>                         #required
              - TASK: managed
                deployMethod: upgrade | replace | blueGreen
        

        In this case, the deploy job uses the deployment name as the value given for deployName tag. Note that blueGreen deployments will have a suffix of build number in its deployment name. So deployment will be of format deployName-buildNumber in case blueGreen deployments.

        Note that, upgrade and replace deployments expect deployName to be present during the first deployment. The name of the first deployment will be the name that will be used in subsequent deployments for upgrade/replace deploy methods. Hence, modifying the deployName will not take effect in a job for those types.