Skip to content

Comments

Add kseal to README#1852

Merged
alvneiayu merged 1 commit intobitnami-labs:mainfrom
eznix86:main
Dec 18, 2025
Merged

Add kseal to README#1852
alvneiayu merged 1 commit intobitnami-labs:mainfrom
eznix86:main

Conversation

@eznix86
Copy link
Contributor

@eznix86 eznix86 commented Dec 16, 2025

Description of the change

Adds kseal in the README, a companion CLI that simplifies working with Bitnami Sealed Secrets. This wraps underlying kubeseal operations to make day-to-day tasks more ergonomic.

Benefits

  • Provides an alternative for viewing, exporting, encrypting Secrets and decrypting SealedSecrets
  • Support multiple manifests in a single file.

Example

# app.yaml
kind: ConfigMap
---
kind: Secret <--- will only encrypt this part and keep the order if `--in-place` is specified. Same for decrypting with SealedSecrets.
---
kind: Deployment

Possible drawbacks

Applicable issues

Additional information

Example usage from kseal:

### Common Usage

# Generate a config file 
kseal init 
# .kseal-config.yaml
# version: 0.33.1 <---- which version of kubeseal to use for this project by default picks the last one.
# controller_name: sealed-secrets
# controller_namespace: sealed-secrets
# unsealed_dir: .unsealed <--- useful for export.


# View a decrypted secret from a SealedSecret manifest (requires cluster access)
kseal cat sealed.yaml

# Export decrypted secrets
kseal export sealed.yaml

# use files yaml to grab the manifests
kseal export --all

# use ownerReferences to get the secrets.
kseal export --all --from-cluster

# Encrypt a plaintext Secret (use kubeseal behind the scene)
kseal encrypt secret.yaml -o sealed.yaml
kseal encrypt secret.yaml --in-place
### Offline Decryption

# One-time: export private keys while cluster access is available
kseal export-keys

# Decrypt without cluster access (use kubeseal behind the scene)
kseal decrypt sealed.yaml
kseal decrypt-all --in-place
### Version Management

kseal version update # latest
kseal version set 0.33.1 # set global unless specified in the config
kseal version list # view all version of kubeseal installed

Signed-off-by: Bruno Bernard <[email protected]>
@alvneiayu
Copy link
Collaborator

hi @eznix86

First, thank you so much for sending us a PR sharing your project. Looks so interesting.

The procedure to include projects like this, is to include the URL to the project in our section of related project:

https://github.com/bitnami-labs/sealed-secrets/blob/main/README.md#related-projects

We are not including documentation of specific projects, just documentation related to Sealed Secrets by itself.

Could you send us a new PR including your project in this related section, please?

I will be pleased to include it and review it.

Álvaro

@alvneiayu alvneiayu closed this Dec 18, 2025
@eznix86
Copy link
Contributor Author

eznix86 commented Dec 18, 2025

hi @alvneiayu it is already included in the PR. The documentation i provided in the comments is because the PR template asked so thank you!

Screenshot 2025-12-18 at 15 06 38

@alvneiayu alvneiayu reopened this Dec 18, 2025
@alvneiayu alvneiayu merged commit 3687f78 into bitnami-labs:main Dec 18, 2025
25 of 29 checks passed
@eznix86
Copy link
Contributor Author

eznix86 commented Dec 18, 2025

Thank you !

tmeijn pushed a commit to tmeijn/dotfiles that referenced this pull request Dec 20, 2025
This MR contains the following updates:

| Package | Update | Change |
|---|---|---|
| [bitnami-labs/sealed-secrets](https://github.com/bitnami-labs/sealed-secrets) | minor | `v0.33.1` → `v0.34.0` |

MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot).

**Proposed changes to behavior should be submitted there as MRs.**

---

### Release Notes

<details>
<summary>bitnami-labs/sealed-secrets (bitnami-labs/sealed-secrets)</summary>

### [`v0.34.0`](https://github.com/bitnami-labs/sealed-secrets/blob/HEAD/RELEASE-NOTES.md#v0340)

[Compare Source](bitnami-labs/sealed-secrets@v0.33.1...v0.34.0)

- Add kseal to README ([#&#8203;1852)](bitnami-labs/sealed-secrets#1852))
- Bump golang version to the latest available 1.24 ([#&#8203;1854](bitnami-labs/sealed-secrets#1854))
- Bump k8s.io/code-generator from 0.34.2 to 0.34.3 ([#&#8203;1850](bitnami-labs/sealed-secrets#1850))
- Bump k8s.io/client-go from 0.34.2 to 0.34.3 ([#&#8203;1848](bitnami-labs/sealed-secrets#1848))
- Bump github.com/onsi/ginkgo/v2 from 2.27.2 to 2.27.3 ([#&#8203;1843](bitnami-labs/sealed-secrets#1843))
- Bump distroless/static from `87bce11` to `4b2a093` in /docker ([#&#8203;1846](bitnami-labs/sealed-secrets#1846))
- Bump github.com/onsi/gomega from 1.38.2 to 1.38.3 ([#&#8203;1844](bitnami-labs/sealed-secrets#1844))
- Bump golang.org/x/crypto from 0.45.0 to 0.46.0 ([#&#8203;1845](bitnami-labs/sealed-secrets#1845))
- Make controllers kubeclient QPS & Burst configurable. ([#&#8203;1834](bitnami-labs/sealed-secrets#1834))
- use default method to watch for key secrets ([#&#8203;1831](bitnami-labs/sealed-secrets#1831))
- Bump golang.org/x/crypto from 0.44.0 to 0.45.0 in the go\_modules group across 1 directory ([#&#8203;1840](bitnami-labs/sealed-secrets#1840))
- Bump k8s.io/code-generator from 0.34.1 to 0.34.2 ([#&#8203;1839](bitnami-labs/sealed-secrets#1839))
- Bump golang.org/x/crypto from 0.43.0 to 0.44.0 ([#&#8203;1835](bitnami-labs/sealed-secrets#1835))
- Bump k8s.io/client-go from 0.34.1 to 0.34.2 ([#&#8203;1837](bitnami-labs/sealed-secrets#1837))

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this MR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this MR, check this box

---

This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0Mi41OS4xIiwidXBkYXRlZEluVmVyIjoiNDIuNjQuMSIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOlsiUmVub3ZhdGUgQm90Il19-->
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