Skip to content

Latest commit

 

History

History
45 lines (36 loc) · 2.21 KB

CONTRIBUTING.md

File metadata and controls

45 lines (36 loc) · 2.21 KB

Contributing

For general contribution and community guidelines, please see the community repo.

Contributing

  1. Fork the project
  2. Clone your fork
  3. Make local changes to your fork by editing files
  4. Commit your changes
  5. Push your local changes to the remote server
  6. Create new Pull Request

From here your pull request will be reviewed and once you've responded to all feedback it will be merged into the project. Congratulations, you're a contributor!

Development

If you are using this repository for development purposes, there is some additional functionality that you may find useful.

  • Setting the LOCAL_AUTHENTICATOR environment variable to true will push the Conjur K8s authenticator client and Secretless Broker from your local Docker registry to the remote registry (if used), and will use that image rather than the image from DockerHub.

    This can be useful if you are working on changes to the authenticator client and Secretless Broker.

    • Run ./bin/build in conjur-authn-k8s-client to generate a local Docker image conjur-authn-k8s-client:dev
    • Run ./bin/build in secretless-broker to generate a local Docker image secretless-broker:latest
    • Set LOCAL_AUTHENTICATOR=true
    • Run the ./start script in this repo as usual, and the demo apps will be deployed with your local builds of the authenticator and Secretless.

  • The ANNOTATION_BASED_AUTHN environment variable enables you to toggle whether your deployment uses annotation-configured host identities or if the authentication type is defined in the identity path.