Installation

🚧

We are currently in private Beta and need to provision your account before you follow the steps outlined below. Email us at [email protected] to request access.

The Signadot installation consists of two steps:

  1. Installing the Signadot GitHub Application
  2. Installing the Signadot Operator

Signadot GitHub Application

📘

Install the Signadot GitHub App

GitHub applications can be installed on a GitHub organization to provide access to all members of that organization, or into your personal account just for yourself. In order to install the GitHub application into a GitHub Organization, you must be the administrator. You can select one or more repositories for Signadot Workspaces to listen for events such as pull request status.

Note that the permissions required are:

  1. Read access to metadata & pull requests
  2. Read / write access to commit statuses

This does not provide the application with access to source code in your repositories.

Once the above steps are completed, you should be able to access the Signadot Dashboard

❗️

If you get a "Not Authorized" error message when accessing the Signadot Dashboard, ensure that you are logged into the correct GitHub account with admin role associated with the GitHub organization used above.

Repository Configuration

Some Workspaces features may need additional metadata about your GitHub repositories, which you provide by creating a signadot.yaml file at the root of each repository. See the Repository Configuration reference page for the available options.

Note that you can skip this step for now if you aren't ready to use the features that need it, such as previewing configuration changes.

Signadot Operator

You would need to install the Signadot Operator in all the clusters that have baseline versions of services deployed.

For each cluster, you will need a cluster token that can be obtained by creating a new cluster and a cluster token using the Signadot Dashboard. Copy the cluster token value for the next installation step.

You would need to run the following commands to install the Signadot Operator. Paste the cluster token copied above when creating the secret as shown in the kubectl command below.

# Install with Helm 3.
helm repo add signadot https://charts.signadot.com
helm install signadot-workspaces signadot/workspaces

# Register the cluster agent.
# Replace "..." with the token value found in the web console.
kubectl -n signadot create secret generic cluster-agent --from-literal=token=...

You can optionally specify additional labels to be added to all Signadot components through a Helm values.yaml file or on the command line:

# Add custom labels.
helm install signadot-workspaces signadot/workspaces \
  --set 'podLabels.some-label=value' \
  --set 'podLabels.other-label=value'

Upgrade

You can upgrade an existing installation by running the following Helm commands.

# To upgrade an existing release
helm repo update
helm upgrade signadot-workspaces signadot/workspaces

Did this page help you?