docs/en/Integration.md · typeable/octopod

git.iko.soy/typeable/octopod

typeable/octopod/docs/en/Integration.md

36 lines 1.5 kB history raw

1# Integration into existing CI/CD pipelines

4You likely already have some form of CI integration with your version control system, such as *GitHub Action* or *Travis CI*, to run various checks on your code. Most of these services are set up by providing what is essentially just a shell script that is run under specific conditions.

6You might want to automate deployments even further ― you might want deployments to be automatically created and updated when developers create and update *Pull Requests*.

8_Octopod_ can be interacted with through the _octo CLI_ tool. This tool can be easily called from within a *CI* script.

10## ✨ Creating deployments

12To create a deployment (given that you have already obtained a *Docker Image* and uploaded it to your _Image Registry_ in one of the previous *CI* steps) you simply need to call _octo CLI_ with the following arguments:

14```bash

15octo create -n $NAME -t $IMAGE_TAG

16```

18`$NAME` is the name of the deployment you want to create. You can set it to be the name of the branch for example.

20`$IMAGE_TAG` is the _tag_ of the docker image you want to deploy.

22## 🚀 Updating deployments

24Updating deployments is done using the same arguments, but you need to call the `create` command, instead of the `update` command:

26```bash

27octo update -n $NAME -t $IMAGE_TAG

28```

30

32

33 Star the project of you like it

34

36<a href="https://typeable.io"><img src="../../img/typeable_logo.svg" width="177px"></img></a>