git.iko.soy/typeable/octopod
on 1.2.1 help sign in
typeable/octopod/docs/en/Integration.md
35 lines 1.5 kB history raw
1# Integration into existing CI/CD pipelines
3<details>
4 <summary>Table of contents</summary>
6- [✨ Creating deployments](#-creating-deployments)
7- [🚀 Updating deployments](#-updating-deployments)
9</details>
11You 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.
13You might want to automate deployments even further ― you might want deployments to be automatically created and updated when developers create and update *Pull Requests*.
15_Octopod_ can be interacted with through the _octo CLI_ tool. This tool can be easily called from within a *CI* script.
17## ✨ Creating deployments
19To 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:
21```bash
22octo create -n $NAME -t $IMAGE_TAG
23```
25`$NAME` is the name of the deployment you want to create. You can set it to be the name of the branch for example.
27`$IMAGE_TAG` is the _tag_ of the docker image you want to deploy.
29## 🚀 Updating deployments
31Updating deployments is done using the same arguments, but you need to call `create` command, instead of the `update` command:
33```bash
34octo update -n $NAME -t $IMAGE_TAG
35```