Skip to content

Commit

Permalink
Update to note "make setup" usage
Browse files Browse the repository at this point in the history
  • Loading branch information
jhbeskow committed Mar 19, 2024
1 parent 803de0c commit 3d7d569
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ To get started developing, please install the following software. You do not ha
* [Visual Studio Code Go Extension](https://marketplace.visualstudio.com/items?itemName=golang.go)
* [kubectl](https://kubernetes.io/docs/tasks/tools/)
* [Docker](https://www.docker.com/) or [Podman](https://podman.io/) or another container engine
* [Build Bitwarden SDK libbitwarden_c.so binary](https://github.com/bitwarden/sdk) copied to /usr/lib (NOTE: We will create a Makefile entry to download these automatically in the future)
* [Download the appropriate libbitwarden_c binary](https://github.com/bitwarden/sdk) for your OS and architecture to [src/sm-operator/bw-sdk/internal/cinterface/lib](src/sm-operator/bw-sdk/internal/cinterface/lib). This can be done using `make setup`
* A [Bitwarden Organization with Secrets Manager](https://bitwarden.com/help/sign-up-for-secrets-manager/). You will need the organization ID GUID for your organization.
* An [access token](https://bitwarden.com/help/access-tokens/) for a Secrets Manager service account tied to the projects you want to pull.

Expand Down
2 changes: 2 additions & 0 deletions src/sm-operator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ You will need a Kubernetes cluster to run against. We recommend [KIND](https://s

**Note:** Your controller will automatically use the current context in your kubeconfig file (i.e. whatever cluster `kubectl cluster-info` shows).

This project uses the Secrets Manager golang SDK. This SDK requires some binaries exist inside the project. Run `make setup` to download the appropriate binaries into the project.

### How it works

This project aims to follow the Kubernetes [Operator pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/).
Expand Down

0 comments on commit 3d7d569

Please sign in to comment.