Skip to content

feat: add byo-git documentation#140

Open
CasLubbers wants to merge 3 commits intomainfrom
APL-1513
Open

feat: add byo-git documentation#140
CasLubbers wants to merge 3 commits intomainfrom
APL-1513

Conversation

@CasLubbers
Copy link
Contributor

No description provided.

When using an external Git repository (BYO Git), disaster recovery is significantly simplified. The platform configuration is already stored externally, so Gitea backup and restore is not required. To restore the platform, you only need:

- The age keys (`privateKey` and `publicKey`) used for SOPS encryption.
- Access to the external Git repository.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Access credentials

- The age keys (`privateKey` and `publicKey`) used for SOPS encryption.
- Access to the external Git repository.

Make sure to store the age keys securely outside of the cluster.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be useful to provide a kubectl command to fetch age keys from the cluster.


## Prerequisites

- A Kubernetes cluster with a minimum of 4 nodes with 4 GB of memory each. The recommended setup is 3 nodes with 8 GB of memory each.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I find it irrelevant to the future description. The required capacity is rather part of the installation prerequisites. We will lower down the required resource once we introduce GtiOps optional feature.

## Prerequisites

- A Kubernetes cluster with a minimum of 4 nodes with 4 GB of memory each. The recommended setup is 3 nodes with 8 GB of memory each.
- A Git repository hosted on GitHub or GitLab.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

An empty git repository accessible from cabernets cluster via the HTTPS protocol.

To install with BYO Git, disable Gitea and add the Git configuration to your `values.yaml`:

```yaml
apps:
Copy link
Contributor

@j-zimnowoda j-zimnowoda Feb 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

are cert-manager, cluster and dns configurations absolutely necessary in this context ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good question, I did not test it without. I actually always test with valid dns and certificates. I have this more setup as an ideal setup.


## Disaster recovery with BYO Git

When using an external Git repository, disaster recovery is significantly simplified. Since the platform configuration is already stored in your external Git provider, there is no need to back up or restore Gitea. To restore the platform, you can re-use the same `values.yaml` from the initial installation. The only addition required is the age keys used for SOPS encryption.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The benefits have been already mentioned in the ## Advantages of BYO Git section.

Add the `privateKey` and `publicKey` to the `kms.sops.age` section of your existing `values.yaml`:

```yaml
kms:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For full picture I would again the

otomi:
  git:
    repoUrl: https://github.com/<owner>/<repo>
    username: <git-username>
    password: <personal-access-token>
    email: <git-email>
    branch: main
sops:
    age:
      privateKey: "<your-age-private-key>"
      publicKey: "<your-age-public-key>"
    provider: age

so a user have a complete picture. I understand that other values are not necessary because everything else is in the git, isn't it?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did not try this. From the top off mind I think it will always first do the helm install. If it does not affect those installations it should work

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

Comments