Bootstrap

The mpas bootstrap command deploys the following components to your cluster:

Flux: A Kubernetes operator that will install and manage the other components.
ocm-controller: A Kubernetes controller that enables the automated deployment of software using the Open Component Model and Flux.
git-controller: A Kubernetes controller that will create pull requests in the target Github repository when changes are made to the cluster.
replication-controller: A Kubernetes controller that replicates everything defined and bundled in an OCM component version (and that the consumer subscribed to) into the local OCI registry of the cluster.
mpas-product-controller: A Kubernetes controller responsible for creating the custom resource Product.
mpas-project-controller: A Kubernetes controller responsible for bootstrapping a whole project and creating relevant access credentials, service accounts, roles and the main repository. It reconciles the Project resource.

Besides the above components, the mpas bootstrap command will also push the corresponding component manifests to the target Git repository and configure Flux to continuously update the installed components from the target Git repository.

After the mpas bootstrap command is executed, the cluster is ready to deploy software in a GitOps fashion using the Open Component Model and MPAS.

  <div class="w-100"> To bootstrap <code>MPAS</code>, the person running the command must have <strong>cluster admin rights</strong> for the target Kubernetes cluster.

It is also required that the person running the command to be the owner of the GitHub repository, or to have admin rights of a GitHub organization.

Bootstrap for GitHub

GitHub Personal Access Token (PAT)

For accessing the GitHub API, the boostrap command requires a GitHub personal access token (PAT) with administration permissions.

The GitHub PAT can be exported as environment variable:

export GITHUB_TOKEN=<your-github-pat>

If the GITHUB_TOKEN environment variable is not set, the mpas bootstrap command will prompt for the GitHub PAT.

  <div class="w-100"> Note that the GitHub PAT is stored in the cluster as a <strong>Kubernetes Secret</strong> named <code>flux-system</code>

inside the flux-system namespace.

Personal account

Run the bootstrap for a repository on your personal GitHub account:

mpas bootstrap github \
  --owner=<your-github-username> \
  --repository=<your-github-repository> \
  --path=clusters/my-cluster \
  --dev \
  --personal

If the specified repository does not exist, the mpas bootstrap command will create it as a private repository. If you wish to create a public repository, you can use the --private=false flag.

Organization

If you want to bootstrap MPAS for a repository owned by an GitHub organization, it is recommended to create a dedicated GitHub user for MPAS and use that user to bootstrap the repository.

Run the bootstrap for a repository owned by a GitHub organization:

mpas bootstrap github \
  --owner=<your-github-organization> \
  --repository=<your-github-repository> \
  --path=clusters/my-cluster \
  --dev

Bootstrap for Gitea

Gitea API token

For accessing the Gitea API, the boostrap command requires a Gitea API token with administration permissions.

The Gitea API Token can be exported as an environment variable:

export GITEA_TOKEN=<your-gitea-api-token>

If the GITEA_TOKEN environment variable is not set, the mpas bootstrap command will prompt for the Gitea API token.

  <div class="w-100"> Note that the Gitea API Token is stored in the cluster as a <strong>Kubernetes Secret</strong> named <code>flux-system</code>

inside the flux-system namespace.

Personal account

Run bootstrap for a repository on your personal Gitea account:

mpas bootstrap gitea \
  --owner=<your-gite  -username> \
  --repository=<your-gitea-repository> \
  --path=clusters/my-cluster \
  --dev \
  --personal

If the specified repository does not exist, the mpas bootstrap command will create it as a private repository. If you wish to create a public repository, you can use the --private=false flag.

Organization

If you want to bootstrap MPAS for a repository owned by an Gitea organization, it is recommended to create a dedicated Gitea user for MPAS and use that user to bootstrap the repository.

Run the bootstrap for a repository owned by a Gitea organization:

mpas bootstrap gitea \
  --owner=<your-gitea-organization> \
  --repository=<your-gitea-repository> \
  --path=clusters/my-cluster \
  --dev

Bootstrap for an air-gapped environment

If you want to bootstrap MPAS for a repository in an air-gapped environment, only Gitea is supported at the moment.

Export the bootstrap components bundle

To bootstrap MPAS in an air-gapped environment, you need to export the bootstrap components bundle from the MPAS default registry.

mpas bootstrap \
  --export \
  --export-path=/tmp

The above command will export the bootstrap components archive to /tmp/mpas-bundle.tar.gz.

It is then possible to import the bootstrap components bundle into an air-gapped environment registry and use it to bootstrap MPAS for a repository in that environment.

mpas bootstrap gitea \
  --owner=<your-gitea-organization> \
  --repository=<your-gitea-repository> \
  --from-file=/tmp/mpas-bundle.tar.gz \
  --registry=<your-air-gapped-registry> \
  --path=clusters/my-cluster \
  --dev

The above command will copy the bootstrap components from the bundle archive to the specified air-gapped registry and bootstrap MPAS for the specified repository.