Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
bakito committed Jan 14, 2024
1 parent e86cc61 commit 8ed2ebb
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 11 deletions.
8 changes: 4 additions & 4 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,10 @@ GINKGO ?= $(LOCALBIN)/ginkgo
## Tool Versions
SEMVER_VERSION ?= v1.1.3
MOCKGEN_VERSION ?= v1.6.0
GOLANGCI_LINT_VERSION ?= v1.54.2
GORELEASER_VERSION ?= v1.21.2
HELM_DOCS_VERSION ?= v1.11.3
GINKGO_VERSION ?= v2.13.0
GOLANGCI_LINT_VERSION ?= v1.55.2
GORELEASER_VERSION ?= v1.23.0
HELM_DOCS_VERSION ?= v1.12.0
GINKGO_VERSION ?= v2.14.0

## Tool Installer
.PHONY: semver
Expand Down
26 changes: 19 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,22 @@
<img src="./assets/logo.png" />
<br><br>

A web interface for [Sealed Secrets](https://github.com/bitnami-labs/sealed-secrets) by Bitnami.
A web interface for [Sealed Secrets](https://github.com/bitnami-labs/sealed-secrets) by Bitnami.

<img src="./assets/example1.png" width="100%" />
<img src="./assets/example2.png" width="100%" />
</div>

**Sealed Secrets Web** is a web interface for [Sealed Secrets](https://github.com/bitnami-labs/sealed-secrets) by Bitnami. The web interface let you encode, decode the keys in the `data` field of a secret, load existing Sealed Secrets and create Sealed Secrets. Under the hood it uses the [kubeseal](https://github.com/bitnami-labs/sealed-secrets/tree/master/cmd/kubeseal) command-line tool to encrypt your secrets. The web interface should be installed to your Kubernetes cluster, so your developers do not need access to your cluster via kubectl.
**Sealed Secrets Web** is a web interface for [Sealed Secrets](https://github.com/bitnami-labs/sealed-secrets) by
Bitnami. The web interface let you encode, decode the keys in the `data` field of a secret, load existing Sealed Secrets
and create Sealed Secrets. Under the hood it uses Sealed Secrets service API to encrypt your secrets. The web interface
should be installed to your Kubernetes cluster, so your developers do not need access to
your cluster via kubectl.

- **Encode:** Base64 encodes each key in the `stringData` field in a secret.
- **Decode:** Base64 decodes each key in the `data` field in a secret.
- **Secrets:** Returns a list of all Sealed Secrets in all namespaces. With a click on the Sealed Secret the decrypted Kubernetes secret is loaded.
- **Secrets:** Returns a list of all Sealed Secrets in all namespaces. With a click on the Sealed Secret the decrypted
Kubernetes secret is loaded.
- **Seal:** Encrypt a Kubernetes secret and creates the Sealed Secret.
- **Validate:** Validate a Sealed Secret.

Expand All @@ -31,7 +36,8 @@ helm repo update
helm upgrade --install sealed-secrets-web bakito/sealed-secrets-web
```

To modify the settings for Sealed Secrets you can modify the arguments for the Docker image with the `--set` flag. For example you can set a different `controller-name` during the installation with the following command:
To modify the settings for Sealed Secrets you can modify the arguments for the Docker image with the `--set` flag. For
example you can set a different `controller-name` during the installation with the following command:

```sh
helm upgrade --install sealed-secrets-web bakito/sealed-secrets-web \
Expand All @@ -41,6 +47,7 @@ helm upgrade --install sealed-secrets-web bakito/sealed-secrets-web \
```

or if you want to disable ability to load existing secrets, and use the tool purelly to seal new ones you can use:

```sh
helm upgrade --install sealed-secrets-web bakito/sealed-secrets-web \
--set disableLoadSecrets=true
Expand All @@ -54,7 +61,8 @@ helm template . -f values.yaml
```

You can check helm values available at https://github.com/bakito/sealed-secrets-web/blob/main/chart/values.yaml
Also, check available application options at https://github.com/bakito/sealed-secrets-web/blob/main/pkg/config/types.go#L14-L22
Also, check available application options
at https://github.com/bakito/sealed-secrets-web/blob/main/pkg/config/types.go#L14-L22

## Api Usage

Expand Down Expand Up @@ -91,7 +99,10 @@ curl -request POST 'https://<SEALED_SECRETS_WEB_BASE_URL>/api/raw' \
```

### Validate sealed secret
> **_NOTE:_** Validate is only available when using cluster internal api (e.g. certURL not set) see [bitnami-labs/sealed-secrets](https://github.com/bitnami-labs/sealed-secrets/issues/1208)

> **_NOTE:_** Validate is only available when using cluster internal api (e.g. certURL not set)
> see [bitnami-labs/sealed-secrets](https://github.com/bitnami-labs/sealed-secrets/issues/1208)
```bash
curl --request POST 'https://<SEALED_SECRETS_WEB_BASE_URL>/api/validate' \
--header 'Accept: application/x-yaml' \
Expand All @@ -100,7 +111,8 @@ curl --request POST 'https://<SEALED_SECRETS_WEB_BASE_URL>/api/validate' \

## Development

For development, we are using a local Kubernetes cluster using kind. When the cluster is created we install **Sealed Secrets** using Helm:
For development, we are using a local Kubernetes cluster using kind. When the cluster is created we install **Sealed
Secrets** using Helm:

```sh
./run_local.sh
Expand Down

0 comments on commit 8ed2ebb

Please sign in to comment.