Skip to content

Commit

Permalink
feat: add sealed secrets docs (#53)
Browse files Browse the repository at this point in the history
* feat: add sealed secrets docs

* feat: update sealed secrets docs page
  • Loading branch information
ferruhcihan authored Feb 27, 2024
1 parent 005adcf commit d64b3d1
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 3 deletions.
45 changes: 45 additions & 0 deletions docs/apps/sealedsecrets.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
slug: sealed-secrets
title: Sealed Secrets
sidebar_label: Sealed Secrets
---

Encrypt your Secret into a SealedSecret, which is safe to store - even inside a public repository.

## Overview

[Bitnami Sealed Secrets](https://github.com/bitnami-labs/sealed-secrets) is a controller that allows you to encrypt your kubernetes secrets and store them in a secure manner, even in public repositories. The controller works by encrypting your secret into a SealedSecret, which can only be decrypted by the sealed secrets controller in your cluster.

## Bring your own certificates

:::info AlERT
You can use your certificates for the disaster recovery purpose. Please make sure to download encryption keys.
:::

While the controller generates its own certificates upon deployment, you also have the option to bring your own certificates. This allows the controller to consume certificates from a secret labeled with `sealedsecrets.bitnami.com/sealed-secrets-key=active`. The Secret should reside in the `sealed-secrets` namespace, which must be the same as the controller's namespace. You can have multiple secrets with this label.

To configure the certificates, add the following to the `values.yaml` when installing Otomi:

```yaml
apps:
sealed-secrets:
enabled: true
bootstrap:
apiVersion: v1
items:
- apiVersion: v1
data:
tls.crt: <tls-crt>
tls.key: <tls-key>
kind: Secret
metadata:
generateName: sealed-secrets-key
labels:
sealedsecrets.bitnami.com/sealed-secrets-key: active
name: <sealed-secrets-name>
namespace: sealed-secrets
type: kubernetes.io/tls
kind: List
```
Make sure to replace `<tls-crt>`, `<tls-key>`, `<sealed-secrets-name>` with your actual certificate data and sealed secrets name.
1 change: 1 addition & 0 deletions product/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ Otomi Core is the heart of Otomi and contains a suite of the following integrate
- [Cloudnative-pg](https://github.com/cloudnative-pg/cloudnative-pg): Open source operator designed to manage PostgreSQL workloads
- [Grafana Tempo](https://github.com/grafana/tempo): High-scale distributed tracing backend
- [OpenTelemetry](https://github.com/open-telemetry/opentelemetry-operator): Instrument, generate, collect, and export telemetry data to help you analyze your software’s performance and behavior
- [Sealed Secrets](https://github.com/bitnami-labs/sealed-secrets): Encrypt your Secret into a SealedSecret, which is safe to store - even inside a public repository.

### Catagories

Expand Down
7 changes: 4 additions & 3 deletions sidebar-docs.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ module.exports = {
"get-started/promo",
"get-started/prerequisites",
{
"Installation": [
Installation: [
"get-started/installation/overview",
"get-started/installation/aws",
"get-started/installation/azure",
Expand All @@ -22,7 +22,7 @@ module.exports = {
"get-started/installation/kms",
"get-started/installation/entrypoint",
"get-started/installation/byo-wildcard",
]
],
},
"get-started/activation",
{
Expand Down Expand Up @@ -179,6 +179,7 @@ module.exports = {
"apps/minio",
"apps/otel",
"apps/prometheus",
"apps/sealedsecrets",
"apps/thanos",
"apps/trivy",
"apps/tekton",
Expand All @@ -190,4 +191,4 @@ module.exports = {
// "tutorials/tutorial-1",
// ],
},
};
}

0 comments on commit d64b3d1

Please sign in to comment.