Skip to content

Latest commit

 

History

History
106 lines (71 loc) · 3.16 KB

README.md

File metadata and controls

106 lines (71 loc) · 3.16 KB

ECR token refresh operator

Release Software License Powered By: Edenlab

The ECR token refresh operator refreshes automatically the Amazon ECR authorization token before it expires.

Description

Amazon Elastic Container Registry Private Registry Authentication provides a temporary authorization token valid only for 12 hours. This operator refreshes automatically the Amazon ECR authorization token before it expires, reducing the overhead in managing the authentication flow. This operator contains one CRD which directs the operator to create/refresh Amazon ECR authorization token in a timely manner:

spec:
  ecrRegistry: 123456789012.dkr.ecr.us-east-1.amazonaws.com
  frequency: 8h
  region: us-east-1

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/ecr_v1alpha1_ecrtokenrefresh.yaml
  1. Build and push your image to the location specified by IMG:
make docker-build docker-push IMG=<some-registry>/core.ecr-token-refresh.operators.infra:tag
  1. Deploy the controller to the cluster with the image specified by IMG:
make deploy IMG=<some-registry>/core.ecr-token-refresh.operators.infra:tag

Uninstall CRDs

To delete the CRDs from the cluster:

make uninstall

Undeploy controller

UnDeploy the controller from the cluster:

make undeploy

Contributing

How it works

This project aims to follow the Kubernetes Operator pattern.

It uses Controllers, which provide a reconcile function responsible for synchronizing resources until the desired state is reached on the cluster.

Test It Out

  1. Install the CRDs into the cluster:
make install
  1. 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