external-secrets/docs/contributing-devguide.md

Getting Started

You must have a working Go environment and then clone the repo:

git clone https://github.com/external-secrets/external-secrets.git
cd external-secrets

Building & Testing

The project uses the make build system. It'll run code generators, tests and static code analysis.

Building the operator binary and docker image:

make build
make docker-build IMG=external-secrets:latest

Run tests and lint the code:

make test
make lint

Build the documentation:

make docs

Installing

To install the External Secret Operator's CRDs into a Kubernetes Cluster run:

make install

Apply the sample resources:

kubectl apply -f config/samples/external-secrets_v1alpha1_secretstore.yaml
kubectl apply -f config/samples/external-secrets_v1alpha1_externalsecret.yaml

You can run the controller on your host system for development purposes:

make run

To remove the CRDs run:

make uninstall

!!! note "Contributing Flow" The HOW TO guide for contributing is at the Contributing Process page.

Documentation

We use mkdocs material to generate this documentation. See /docs for the source code and /hack/api-docs for the build process.

When writing documentation it is advised to run the mkdocs server with livereload:

make serve-docs

Run the following command to run a complete build. The rendered assets are available under /site.

make docs

# inspect the build with this one-liner
python -m http.server 8000 --directory site