Skip to main content

Production installation

⚠️ We highly recommend using kubriX-prime for production workload and professional services from suXess-it. Still, you can use kubriX OSS also for small production environments without special security or compliance needs at your own risk.

Bootstrap automation VS manual setup​

Many of the next steps will be probably automated in the future by the bootstrap automation you already use in Quickstart Kubernetes Installation. However, with this tutorial we want to show you how you can customize your kubriX installation in the most flexible way.

🔭 Future Outlook: in the future, this bootstrapping process could be also a Kubernetes job or operator, so even the bootstrap process could get deployed on Kubernetes.

Clone latest kubriX release to your git Repository​

Create your own empty git repository on your VCS, clone it to your local machine and merge latest kubriX release into it:

git clone <your-repo>
cd <your-repo-directory>
git remote add kubriX-upstream https://github.com/suxess-it/kubriX.git
git fetch kubriX-upstream --tags
latestTag=$(git describe --tags "$(git rev-list --tags --max-count=1 --remotes=kubriX-upstream/main)"
git switch -c kubriX-upstream "${latestTag}"
git checkout --orphan kubriX-downstream
git push --set-upstream origin publish:main
git checkout main
git pull

Integrating existing managed services​

Think about how you want to deal with

  • DNS resolution (kubriX works best with DNS provider supported by external-secrets)
  • TLS certificates (kubriX uses cert-manager for creating certificates, typically via ACME protocol)
  • Persistent Storage integration (S3 for observability data and backups, ...)
  • Git-Server, Git-Server Repo/Group structure
  • Helm- and Container-Registry
  • Identity-Provider in your company which should get integrated with Keycloak (prime feature)
  • Alerting-Receivers (Chat channels, E-Mails, .. any receivers supported by Alertmanager)

Preparing the .secrets files​

All platform services get dynamically generated credentials during first installation according to .secrets/.envoss.yaml. We highly recommend to not change this, unless you know what you do.

Preparing values files​

kubriX consists in its core of an ArgoCD AppOfApps definition - called sx-bootstrap-app - which defines the platform services. It is defined in a values file in the platform-apps/target-chart directory. In the installer in the next step uses KUBRIX_TARGET_TYPE variable, which references to this part if the file values-<target-type>.yaml.

The .default.valueFiles list defines the default values files with which each platform app chart should get deployed.

The .applications list defines all platform apps, which should get deployed.

default:
  valueFiles:
  - values-kubriX-hub-prod-aws.yaml

applications:

  - name: ingress-nginx
    annotations:
      argocd.argoproj.io/sync-wave: "-11"

  - name: cert-manager
    annotations:
      argocd.argoproj.io/sync-wave: "-10"

You can set several attributes per application, which you can see in the example files. These apps reference to directories in the platform-apps/charts/ directory.

🔭 Future Outlook: we will probably introduce also an attribute repo so platform apps can also live in different git/oci repositories.

Each platform app can then get customized via values files in platform-apps/charts/<app>/ directory. kubriX delivers out-of-the-box values for different flavors which you can extend or change for your needs.

After customizing all values files, commit and push your changes to your own kubriX gitops repo in the branch you want to sync to this cluster in the future.

💡 Tip: We recommend stage specific branches, which get merged from main. Described in storage options - stage specific branches

Running the installer​

The installer will use some scripts of your local repository and apply platform apps from your remote repository. So be sure that all your applied changes are pushed to your remote repository and you also checked out snd pulled your latest changes from your remote repository.

export KUBRIX_REPO=https://github.com/<your-org>/<your-kubrix-repo>
export KUBRIX_REPO_BRANCH=<your-stage-branch>
export KUBRIX_REPO_USERNAME=dummy
export KUBRIX_REPO_PASSWORD=<your-repo-read-access-token>
export KUBRIX_TARGET_TYPE=<your-target-type> #in upper case!
export KUBRIX_BACKSTAGE_GITHUB_TOKEN=<your-repo-read-access-token>
export KUBRIX_BOOTSTRAP_MAX_WAIT_TIME=3600

# install-platform from new repository
./install-platform.sh

Post-Installation tasks​

Next steps​