Installation #

Downloading a single binary is all it takes to get started. With the SetOps command-line interface (CLI), you can configure your app environment, deploy, and monitor your app.

Downloading the CLI #

Configure Syntax Highlighting for Visual Studio Code #

When editing SetOps stage definitions you can configure Visual Studio Code to check your definition agains the official SetOps JSON Schema. This allows for autocomplete and validation.

1. Install Red Hats YAML extension

2. Go to your user setting in json view

3. Add the following code snippet to configure the schema for all files ending with .setops.yaml

   ...
   "yaml.schemas": {
       "https://api.setops.co/schema/latest/stage.setops.json": "*.setops.yaml"
   },
   ...
   

Sign up #

If you are new to SetOps you need to be invited to a SetOps Organization by another user. Follow the invitation email’s instructions to set a password for your account. You then have access to the resources you have been invited to.

Log In #

To log into your account, run:

$ setops login

SetOps will open a browser window where you can provide your credentials. If a browser window cannot be opened, SetOps will print the link to your terminal, so you can copy it to a browser window. After successful authorization, SetOps will obtain a short living access token and a refresh token for your local CLI and store it in ~/.setops.yml alongside the provided org.

It will also attempt to configure your docker installation to be able to authenticate and push to the SetOps registry. It places a helper script docker-credential-setops in your PATH and registers it in your Docker configuration at ~/.docker/config.json. You can skip the setup using the --no-setup flag with the login command. If the automatic setup fails, you can perform a Manual Setup.

You are now ready to use the SetOps CLI.

The interactive login via a browser will not work when running the setops login command in a non-interactive environment, like a CI job. In this case, you can call setops login --service-user and pass in a username and password. However, this should only be used if it is really required since username and password are directly passed into the CLI. For better security, only an access token is stored in ~/.setops.yml, which means you need to log in again after 4 hours when the access token expires. Login via --service-user flag does not support social providers such as GitHub or Google. We recommend creating a dedicated service user account used exclusively in these scenarios.

Switch Organizations #

Suppose you are a member of multiple organizations, you can switch between them with setops organization:switch <ORGANIZATION> after successful login.

Logout #

If you want to log out from SetOps, you can do so by running setops logout. This will deauthorize the current session in your terminal. Please note that your browser will stay logged in, so you will not have to provide your credentials if you want to log in again. To also log out from the browser (e.g., to switch accounts), use setops logout --browser.

Manual Setup #

To authenticate with the SetOps registry and push images, Docker needs to be configured. SetOps uses a credential-helper, a small script that handles the authentication for Docker. The script must be placed in your PATH and registered in your Docker configuration. These steps should be performed automatically during login. If the automatic setup fails, you can place and register the Docker credential-helper manually:

1. Make sure Docker is installed by running docker --version from your terminal
2. Create a file named docker-credential-setops in a directory that is in your PATH
3. Copy the following script to the file and save it

   #!/bin/bash
   
   setops docker $@
   

   The script forwards Docker’s request for credentials to the SetOps CLI.

4. Make the file executable e.g. by running chmod a+x /path/to/file/docker-credential-setops
5. Test the script by running docker-credential-setops get from your terminal
6. Open ~/.docker/config.json
7. Add the following key to the configuration and save the file

   "credHelpers": {
      "api.setops.co": "setops"
   }
   

You are now ready to use SetOps with Docker.

Going further #

Read more about the concepts which power SetOps.