config.rig.dev/v1alpha1

Package v1alpha1 contains API Schema definitions for the config v1alpha1 API group

Resource Types

• OperatorConfig
• PlatformConfig

Auth

Auth specifies authentication configuration.

Appears in:

• PlatformConfig

Field	Description
secret string	Secret specifies a secret which will be used for jwt signatures.
certificateFile string	CertificateFile specifies a path to a PEM encoded certificate file which will be used for validating jwt signatures.
certificateKeyFile string	CertificateKeyFile specifies a path to a PEM encoded certificate key which will be used for jwt signatures.
disablePasswords boolean	DisablePasswords disables password authentication. This makes sense if you want to require SSO, as login method.
sso SSO	SSO specifies single sign on configuration.
allowRegister boolean	AllowRegister specifies if users are allowed to register new accounts.
requireVerification boolean	IsVerified specifies if users are required to verify their email address.
sendWelcomeEmail boolean	SendWelcomeEmail specifies if a welcome email should be sent to new users. This will use the default email config

CapsuleMatch

Appears in:

• Step

Field	Description
namespaces string array	If set, only capsules in one of the namespaces given will have this step run.
names string array	If set, only execute the plugin on the capsules specified.
annotations object (keys:string, values:string)	If set, only execute the plugin on the capsules matching the annotations.
enableForPlatform boolean	If set, will enable the step for the Rig platform which is a Capsule as well

CapsuleStep

Appears in:

• Pipeline

Field	Description
plugin string	The plugin to use for handling the capsule step. fx. "rigdev.ingress_routes" for routesStep will create an ingress resource per route. fx. "rigdev.deployment" for deploymentStep will use the default deployment plugin.
config string	Config is a string defining the plugin-specific configuration of the plugin.

Client

Client holds various client configuration

Appears in:

• PlatformConfig

Field	Description
postgres ClientPostgres	Postgres holds configuration for the postgres client.
docker ClientDocker	Docker sets the host for the Docker client.
mailjet ClientMailjet	Deprecated: use 'client.mailjets' instead. Mailjet sets the API key and secret for the Mailjet client.
mailjets object (keys:string, values:ClientMailjet)	Mailjets holds configuration for multiple mailjet clients. The key is the id of the client, which should be unique across Mailjet and SMTP clients.
smtp ClientSMTP	Deprecated: use 'client.smtps' instead. SMTP sets the host, port, username and password for the SMTP client.
smtps object (keys:string, values:ClientSMTP)	SMTPs holds configuration for muliple SMTP clients. The key is the id of the client, which should be unique across Mailjet and SMTP clients.
operator ClientOperator	Operator sets the base url for the Operator client.
slack object (keys:string, values:ClientSlack)	Slack holds configuration for sending slack messages. The key is the id of the client. For example the workspace in which the app is installed
git ClientGit	Git client configuration for communicating with multiple repositories.

ClientDocker

ClientDocker specifies the configuration for the docker client.

Appears in:

• Client

Field	Description
host string	Host where the docker daemon can be reached.

ClientGit

ClientGit contains configuration for git integrations. A given git repository can have authentication from either Auths or GitHubAuths with preference for GitHubAuths if there is a match.

Appears in:

• Client

Field	Description
auths GitAuth array	Auths the git client can behave as.
gitHubAuths GitHub array	GitHubAuths is authentication information for GitHub repositories.
gitLabAuths GitLab array	GitLabAuths is the authentication information for GitLab repositories.
author GitAuthor	Author used when creating commits.

ClientMailjet

ClientMailjet specifes the configuration for the mailjet client.

Appears in:

• Client

Field	Description
apiKey string	APIKey is the mailjet API key
secretKey string	SecretKey is the mailjet secret key

ClientOperator

ClientOperator specifies the configuration for the operator client.

Appears in:

• Client

Field	Description
baseUrl string	BaseURL is the URL used to connect to the operator API

ClientPostgres

ClientPostgres specifies the configuration for the postgres client.

Appears in:

• Client

Field	Description
user string	User is the database user used when connecting to the postgres database.
password string	Password is the password used when connecting to the postgres database.
host string	Host is the host where the postgres database can be reached.
port integer	Port is the port of the postgres database server.
database string	Database in the postgres server to use
insecure boolean	Insecure is wether to use SSL when connecting to the postgres server

ClientSMTP

ClientSMTP specifies the configuration for the SMTP client.

Appears in:

• Client

Field	Description
host string	Host is the SMTP server host.
port integer	Port is the SMTP server port to use.
username string	Username used when connecting to the SMTP server.
password string	Password used when connecting to the SMTP server.

ClientSlack

Appears in:

• Client

Field	Description
token string	Slack authentication token.

Cluster

Cluster specifies cluster configuration

Appears in:

• PlatformConfig

Field	Description
url string	URL to communicate to the cluster. If set, a Token and CertificateAuthority should be provided as well. If not set, the cluster is interpreted to be the cluster in which the platform runs.
token string	Token for communicating with the cluster. Available through a service-account's secret.
script string	Script to execute for getting an access-token to the cluster. The output is expected to be a json-encoding of an ExecCredential. See https://pkg.go.dev/k8s.io/client-go@v0.31.0/pkg/apis/clientauthentication/v1beta1#ExecCredential for the format of the struct.
certificateAuthority string	Certificate authority for communicating with the cluster. Available through a service-account's secret.
type ClusterType	Type of the cluster - either docker or k8s.
devRegistry DevRegistry	DevRegistry configuration
git ClusterGit	Git sets up gitops write back for this cluster.
createPullSecrets boolean	If set, secrets will be created if needed, for pulling images.

ClusterGit

ClusterGit specifies configuration for git integration. This can be used to tie rig into a gitops setup.

Appears in:

• Cluster

Field	Description
url string	URL is the git repository URL.
branch string	Branch to commit changes to.
pathPrefix string	PathPrefix path to commit to in git repository. Deprecated: Use pathPrefixes instead.
pathPrefixes PathPrefixes	PathPrefixes path to commit to in git repository
templates GitTemplates	Templates used for commit messages.
credentials GitCredentials	Credentials to use when connecting to git. Deprecated: Use client.git.auths instead.
author GitAuthor	Author used when creating commits. Deprecated: Use client.git.author instead.

ClusterType

Underlying type: string

ClusterType is a cluster type.

Appears in:

• Cluster

CustomPlugin

Appears in:

• Pipeline

Field	Description
image string	The container image which supplies the plugins

DevRegistry

DevRegistry specifies configuration for the dev registry support.

Appears in:

• Cluster

Field	Description
host string	Host is the host used in image names when pushing to the registry from outside of the cluster.
clusterHost string	ClusterHost is the host where the registry can be reached from within the cluster. Any image which is named after Host will be rename to use ClusterHost instead. This ensures that the image can be pulled from within the cluster.

DockerRegistryCredentials

Appears in:

• PlatformConfig

Field	Description
username string	Username for the docker registry.
password string	Password for the docker registry.
script string	Script (shell) to execute that should echo the credentials. The output is expected to be a single line (with new-line termination) of format <username>:<password>.
expire Duration	Expire is the maximum duration a credential will be cached for, before it's recycled. If a cached credential is rejected before this time, it may be renewed before this duration is expired. Default is 12h.

Email

Email holds configuration for sending emails. Either using mailjet or using SMTP

Appears in:

• PlatformConfig

Field	Description
id string	ID is the specified id an email configuration.
from string	From is who is set as the sender of rig emails.
type EmailType	Deprecated: ID for an email configuration is used instead.

EmailType

Underlying type: string

EmailType represents a type of mailing provider

Appears in:

• Email

Extension

Extension is a typed (through JSON Schema) expansion of a Platform resource, that allows extending the default customization.

Appears in:

• PlatformConfig

Field	Description
schema JSONSchemaProps	The schema of the extension, expressed as a json-schema (https://json-schema.org/). While the full syntax is supported, some features may be semantically disabled which would make the Platform not start or not process Rollouts.

GitAuth

Appears in:

• ClientGit

Field	Description
url string	URL is a exact match for the repo-url this auth can be used for.
urlPrefix string	URLPrefix is a prefix-match for the repo urls this auth can be used for. Deprecated: use Match instead
match URLMatch	How the url should be matched. Can either be 'exact' or 'prefix' Defaults to 'exact'
credentials GitCredentials	Credentials to use when connecting to git.
pullingIntervalSeconds integer	If no web hook is confugured, pull the git repository at the set interval instead to fetch changes. Defaults to 3 mins if no value.

GitAuthor

GitAuthor specifies a git commit author

Appears in:

• ClientGit
• ClusterGit

Field	Description
name string	Name of author
email string	Email of author

GitCredentials

GitCredentials specifies how to authenticate against git.

Appears in:

• ClusterGit
• GitAuth

Field	Description
https HTTPSCredential	HTTPS specifies basic auth credentials.
ssh SSHCredential	SSH specifies SSH credentials.

GitHub

GitHub contains configuration specifically for GitHub repositories. To enable pull requests on a GitHub repository, you must add GitHub authentication using appID, installationID and privateKey for a GitHub app with read/write access to pull requests. To have normal read/write access to a repository, you can forego GitHub app authentication if there is a GitAuth section with credentials for the given repository instead. If you have GitHub app authentication for a GitHub app with read/write access to the repository, you don't need a matching GitAuth section.

Appears in:

• ClientGit

Field	Description
orgRepo string	OrgRepo is a string containing the GitHub organization and optionally a repository as well. If both org and repo is given, they should be seperated by a '/', e.g. 'myorg/myrepo'. If repo is not given, e.g. 'myrepo', then it matches all repositories within the org 'myorg'. If both org and repo is given, it matches exactly the repo within the org.
organization string	Organization is the GitHub organization to match. Deprecated: Use OrgRepo instead
repository string	Repository matches the GitHub repository. If empty, matches all. Deprecated: Use OrgRepo instead
auth GitHubAuth	Auth contains GitHub specific authentication configuration.
polling GitHubPolling	Polling contains GitHub specific configuration.

GitHubAuth

GitHubAuth contains authentication information specifically for a GitHub repository. Authentication is done using GitHub apps. See https://docs.rig.dev/operator-manual/gitops#github-authentication for a guide on how to set it up.

Appears in:

• GitHub

Field	Description
appID integer	AppID is the app ID of the GitHub app
installationID integer	InstallationID is the installation ID of the GitHub app
privateKey string	PrivateKey is a PEM encoded SSH private key.
privateKeyPassword string	PrivateKeyPassword is an optional password for the SSH private key.

GitHubPolling

GitHubPolling defines webhook/pulling configuration for a GitHub repository.

Appears in:

• GitHub

Field	Description
webhookSecret string	WebHookSecret is the secret used to validate incoming webhooks.
pullingIntervalSeconds integer	If webHookSecret isn't set, pull the git repository at the set interval instead to fetch changes. Defaults to 3 mins if no value.

GitLab

GitLab contains configuration specifically for GitLab repositories. To enable pull requests on a GitLab repository, you must add GitLab authentication using an access token. To have normal read/write access to a repository, you can forego GitLab access tokens if there is a GitAuth section with credentials for the given repository instead. If you have GitLab authentication for a repository, you don't need a matching GitAuth section.

Appears in:

• ClientGit

Field	Description
groupsProject string	GroupsProject is a string containing a list of GitLab groups and optionally a project Groups are separated by '/' and project by ':', e.g. group/subgroup1/subgroup2:project If a project is given, it matches exactly that project within that sequence of subsgroups If no project is given, it matches all projects within all subgroups which are children of the given group sequence. E.g. 'group' will match 'group/subgroup1:project1' and 'group/subgroup1/subgroup2:project2'
groups string array	Groups is a sequence of GitLab groups. The first is the main group and the rest a nesting of subgroups. If Project is empty, the configuration will match any GitLab repository whose (group, subgroups) sequence where 'groups' is a prefix. Deprecated: Use GroupsProject
project string	Project is the GitLab project of the repository. Can be empty for matching all project names. Deprecated: Use GroupsProject
auth GitLabAuth	Auth contains GitLab specific authentication configuration.
polling GitLabPolling	Polling contains GitLab specific configuration.

GitLabAuth

GitLabAuth contains authentication information specifically for a GitLab repository. Authentication is done using an access token. See https://docs.rig.dev/operator-manual/gitops#gitlab-authentication for a guide on how to set it up.

Appears in:

• GitLab

Field	Description
accessToken string	AccessToken is an accessToken which is used to authenticate against the GitLab repository.

GitLabPolling

GitLabPolling defines webhook/pulling configuration for a GitLab repository.

Appears in:

• GitLab

Field	Description
webhookSecret string	WebHookSecret is the secret used to validate incoming webhooks.
pullingIntervalSeconds integer	If webHookSecret isn't set, pull the git repository at the set interval instead to fetch changes. Defaults to 3 mins if no value.

GitTemplates

GitTemplates specifies the templates used for creating commits.

Appears in:

• ClusterGit

Field	Description
rollout string	Rollout specifies the template used for rollout commits.
delete string	Delete specifies the template used for delete commits.

HTTPSCredential

HTTPSCredential specifies basic auth credentials

Appears in:

• GitCredentials

Field	Description
username string	Username is the basic auth user name
password string	Password is the basic auth password

Logging

Logging specifies logging configuration.

Appears in:

• PlatformConfig

Field	Description
devMode boolean	DevModeEnabled enables verbose logs and changes the logging format to be more human readable.
level Level	Level sets the granularity of logging.

OIDCProvider

OIDCProvider specifies an OIDC provider.

Appears in:

• SSO

Field	Description
name string	Name is a human-readable name of the provider. If set this will be used instead of the provider id (the key in PlatformConfig.Auth.SSO.OIDCProviders)
issuerURL string	IssuerURL is the URL for the OIDC issuer endpoint.
clientID string	ClientID is the OAuth client ID.
clientSecret string	ClientSecret is the OAuth client secret.
allowedDomains string array	AllowedDomains is a list of email domains to allow. If left empty any successful authentication on the provider is allowed.
scopes string array	Scopes is a list of additional scopes other than openid, email and profile.
groupsClaim string	GroupsClaim is the path to a claim in the JWT containing a string or list of strings of group names.
disableJITGroups boolean	DisableJITGroups disables creation of groups found through OIDC in rig.
groupMapping object (keys:string, values:string)	GroupMapping is a mapping from OIDC provided group names to group names used in rig. If an OIDC provided group name is not provided in this mapping we will use the OIDC provided groupname in rig.
icon OIDCProviderIcon	Icon is what icon to show for this provider.
disableUserMerging boolean	DisableUserMerging disallows merging their OIDC account with an existing user in rig. This effectively means, that if a user is created using OIDC, then it can only login using that OIDC provider.

OIDCProviderIcon

Underlying type: string

OIDCProviderIcon is a string representing what provider icon should be shown on the login page. Valid options: "google", "azure", "aws", "facebook", "keycloak".

Appears in:

• OIDCProvider

OperatorConfig

OperatorConfig is the Schema for the operator config API

Field	Description
apiVersion string	config.rig.dev/v1alpha1
kind string	OperatorConfig
webhooksEnabled boolean	WebhooksEnabled sets wether or not webhooks should be enabled. When enabled a certificate should be mounted at the webhook server certificate path. Defaults to true if omitted.
devModeEnabled boolean	DevModeEnabled enables verbose logs and changes the logging format to be more human readable.
leaderElectionEnabled boolean	LeaderElectionEnabled enables leader election when running multiple instances of the operator.
pipeline Pipeline	Pipeline defines the capsule controller pipeline

PathPrefixes

PathPrefixes is the (possibly templated) path prefix to commit to in git repository depending on which resource is being written.

Appears in:

• ClusterGit

Field	Description
capsule string
project string

Pipeline

Appears in:

• OperatorConfig

Field	Description
serviceAccountStep CapsuleStep	How to handle the service account step of capsules in the cluster. Defaults to rigdev.service_account.
deploymentStep CapsuleStep	How to handle the deployment step of capsules in the cluster. Defaults to rigdev.deployment.
routesStep CapsuleStep	How to handle the routes for capsules in the cluster. If left empty, routes will not be handled.
cronJobsStep CapsuleStep	How to handle the cronjob step of capsules in the cluster. Defaults to rigdev.cron_jobs
vpaStep CapsuleStep	How to handle the VPA step of capsules in the cluster. If left empty, no VPAs will be created.
serviceMonitorStep CapsuleStep	How to handle the service monitor step of capsules in the cluster. If left empty, no service monitors will be created. rigdev.service_monitor plugin spawns a Prometheus ServiceMonitor per capsule for use with a Prometheus Operator stack.
steps Step array	Steps to perform as part of running the operator.
customPlugins CustomPlugin array	CustomPlugins enables custom plugins to be injected into the operator. The plugins injected here can then be referenced in 'steps'
capsuleExtensions object (keys:string, values:CapsuleStep)	CapsuleExtensions supported by the Operator. Each extension supported should be configured in the map, with an additional plugin name.

PlatformConfig

PlatformConfig is the Schema for the platform config API

Field	Description
apiVersion string	config.rig.dev/v1alpha1
kind string	PlatformConfig
port integer	Port sets the port the platform should listen on
publicURL string	PublicUrl sets the public url for the platform. This is used for generating urls for the platform when using oauth2.
telemetryEnabled boolean	TelemetryEnabled specifies wether or not we are allowed to collect usage data. Defaults to true.
auth Auth	Auth holds authentication configuration.
client Client	Client holds configuration for clients used in the platform.
repository Repository	Repository specifies the type of db to use along with secret key
cluster Cluster	Cluster holds cluster specific configuration Deprecated: Use clusters instead.
email Email	Email holds the default configuration for sending emails. Either using mailjet or using SMTP.
logging Logging	Logging holds information about the granularity of logging
clusters object (keys:string, values:Cluster)	Clusters the platform has access to.
dockerRegistries object (keys:string, values:DockerRegistryCredentials)	DockerRegistries holds configuration for multiple docker registries. The key is the host-prefix of the registry
capsuleExtensions object (keys:string, values:Extension)	CapsuleExtensions contains typed extensions to the Capsule spec.

Plugin

Appears in:

• Step

Field	Description
tag string	Optional tag which is readable by plugin when executed
name string	Name of the plugin to run. Deprecated, use Plugin.
plugin string	Name of the plugin to run.
config string	Config is a string defining the plugin-specific configuration of the plugin.

Repository

Repository specifies repository configuration

Appears in:

• PlatformConfig

Field	Description
store string	Store is what database will be used, can only be postgres.
secret string	Secret is a secret key used for encrypting sensitive data before saving it in the database.

SSHCredential

SSHCredential specifies SSH credentials

Appears in:

• GitCredentials

Field	Description
privateKey string	PrivateKey is a PEM encoded SSH private key.
password string	PrivateKeyPassword is an optional password for the SSH private key.

SSO

SSO specifies single sign on configuration.

Appears in:

• Auth

Field	Description
oidcProviders object (keys:string, values:OIDCProvider)	OIDCProviders specifies enabled OIDCProviders which can be used for login.

Step

Appears in:

• Pipeline

Field	Description
tag string	Optional tag which is readable by plugins when executed
match CapsuleMatch	Match requirements for running the Step on a given Capsule.
plugins Plugin array	Plugins to run as part of this step.
namespaces string array	If set, only capsules in one of the namespaces given will have this step run. Deprecated, use Match.Namespaces.
capsules string array	If set, only execute the plugin on the capsules specified. Deprecated, use Match.Names.
enableForPlatform boolean	If set, will enable the step for the Rig platform which is a Capsule as well Deprecated, use Match.EnableForPlatform.

URLMatch

Underlying type: string

Appears in:

• GitAuth

---

generated from source code

This page is generated based on go source code. If you have suggestions for improvements for this page, please open an issue at github.com/rigdev/rig, or a pull request with changes to the go source files.