The EBS snapshot provision operator automatically provisions Amazon EBS snapshots to be used in an existing K8S cluster.
For dynamic creation and provisioning of AWC EBS snapshots for a K8S cluster, the following components can be
used: aws-ebs-csi-driver.
and external snapshotter
This approach is good when we want to create the snapshots manually from an existing PVC within the same cluster.
However, if we want to automatically provision AWS EBS snapshots and then use in, for example, in a new K8S cluster for
further
restoration,
then the aws-ebs-csi-driver
and external-snapshotter
do not support such an automated process for a number of
reasons.
The EBS snapshot provision operator makes this possible via the CR:
spec:
# required fields
clusterName: deps-develop # tenant name
region: us-east-1 # AWS region
frequency: 1m # AWS API request frequency to poll the list of snapshots
volumeSnapshotClassName: ebs-csi-snapshot-class # current CSI snapshot class name
- The
VolumeSnapshotClass
parameters are:should contain additional parameters with placeholders for AWS snapshot tags.snapshotClasses: - name: ebs-csi-snapshot-class # . . . parameters: tagSpecification_1: "{{`snapshotNamespace={{ .VolumeSnapshotNamespace }}`}}" tagSpecification_2: "{{`snapshotName={{ .VolumeSnapshotName }}`}}" tagSpecification_3: "{{`snapshotContentName={{ .VolumeSnapshotContentName }}`}}"
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).
- Install Instances of Custom Resources:
kubectl apply -f config/samples/ebs_v1alpha1_ebssnapshotprovision.yaml
- Build and push your image to the location specified by
IMG
:
make docker-build docker-push IMG=<some-registry>/core.ebs-snapshot-provision.operators.infra:tag
- Deploy the controller to the cluster with the image specified by
IMG
:
make deploy IMG=<some-registry>/core.ebs-snapshot-provision.operators.infra:tag
To delete the CRDs from the cluster:
make uninstall
UnDeploy the controller from the cluster:
make undeploy
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.
- Install the CRDs into the cluster:
make install
- 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
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