Skip to content

omnistrate-ctl Integration

Omnistrate CTL has a number of features that enable it to be seamlessly integrated with scripted and automated environments such as CI.

Using omnistrate-ctl with GitHub Actions

Create secrets in your repository for your Omnistrate email and password and use omnistrate-ctl from your Github workflows using Setup Omnistrate CTL Action.

- name: Setup Omnistrate CTL
  uses: omnistrate/setup-omnistrate-ctl@v1
  with:
    email: ${{ secrets.OMNISTRATE_USERNAME }}
    password: ${{ secrets.OMNISTRATE_PASSWORD }}
    version: latest # OPTIONAL

# Execute and example command
- name: Test CTL command
  run: |
    # rum simple command as an example
    omnistrate-ctl --version
    # omctl alias is also supported
    omctl --version

Using omnistrate-ctl with Docker

omnistrate-ctl is packaged and released in a container image that can be used to execute the command:

docker run -t ghcr.io/omnistrate/ctl:latest

To log into the container and execute a series of commands, run the following command:

docker run -it --entrypoint /bin/sh -t ghcr.io/omnistrate/ctl:latest

To persist the credentials across multiple container runs, run the following command

docker run -it -v ~/omnistrate-ctl:/omnistrate/ -t ghcr.io/omnistrate/ctl:latest