nats-account-operator

README

nats-account-operator

The NATS Account Operator provides a declarative approach to managing Authentication and Authorization infrastructure using the NATS Decentralized JWT mechanisms.

Description

There are four CRD types implemented by the operator:

• Operator - Represents a NATS Operator, the administrative entity of a NATS cluster.
• Account - Represents a NATS Account to be managed by an Operator.
• User - Represents a NATS User which exists within an Account.
• SigningKey - Represents a public/private key pair used to sign JWTs.

Further details of the CRD types can be found in the Specification documentation.

Getting Started

You’ll need a Kubernetes cluster to run against. You can use KIND to get a local cluster for testing, or run against a remote cluster. Note: Your controller will automatically use the current context in your kubeconfig file (i.e. whatever cluster kubectl cluster-info shows).

Running on the cluster

1. Install Instances of Custom Resources:

   kubectl apply -f config/samples/
   

2. Build and push your image to the location specified by IMG:

   make docker-build docker-push IMG=<some-registry>/nats-accounts-operator:tag
   

3. Deploy the controller to the cluster with the image specified by IMG:

   make deploy IMG=<some-registry>/nats-accounts-operator:tag
   

Uninstall CRDs

To delete the CRDs from the cluster:

make uninstall

Undeploy controller

UnDeploy the controller to the cluster:

make undeploy

Contributing

View the Development Guide for info on running locally and contributing bug fixes/new features.

How it works

This project aims to follow the Kubernetes Operator pattern

It uses Controllers which provides a reconcile function responsible for synchronizing resources untile the desired state is reached on the cluster

Test It Out

1. Install the CRDs into the cluster:

   make install
   

2. Run your controller (this will run in the foreground, so switch to a new terminal if you want to leave it running):

   make run
   

NOTE: You can also run this in one step by running: make install run

Modifying the API definitions

If you are editing the API definitions, generate the manifests such as CRs or CRDs using:

make manifests

NOTE: Run make --help for more information on all potential make targets

More information can be found via the Kubebuilder Documentation

Creating a release

We're currently using release-please to manage our releases. Once we have a 1.0.0 release this may switch to semantic-release.

1. Create a release PR:

   GITHUB_TOKEN=<your-github-token>
   # use the --release-as flag if you want to control what the next release version will be
   npx release-please release-pr --release-type go --repo-url versori-oss/nats-account-operator --token=$GITHUB_TOKEN
   

2. Merge the release PR via GitHub

3. Create a release:

   # use the --prerelease flag if this is a pre-release
   npx release-please github-release --release-type go --repo-url versori-oss/nats-account-operator --token=$GITHUB_TOKEN
   

License

See LICENSE