From 3d7d5697a401de819bb26769235d1d074c745c83 Mon Sep 17 00:00:00 2001 From: Joel Beskow Date: Tue, 19 Mar 2024 16:28:50 -0500 Subject: [PATCH] Update to note "make setup" usage --- README.md | 2 +- src/sm-operator/README.md | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 84dd18b..ad8e61e 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/src/sm-operator/README.md b/src/sm-operator/README.md index 79d1999..951f850 100644 --- a/src/sm-operator/README.md +++ b/src/sm-operator/README.md @@ -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/).