Skip to content

Latest commit

 

History

History
220 lines (138 loc) · 8.22 KB

makefile.md

File metadata and controls

220 lines (138 loc) · 8.22 KB
Raw

Use of the EBS CSI Driver Makefile

The EBS CSI Driver comes with a Makefile that can be used to develop, build, test, and release the driver. This file documents Makefile targets, the parameters they support, and common usage scenarios.

Prerequisites

The Makefile has the following dependencies:

All other tools are downloaded for you at runtime.

Building

make cluster/image

Build and push an image of the driver for local development. Environment variables are accepted to override the REGISTRY, IMAGE name, and image TAG. Setting FIPS to true will build an image using a FIPS-validated cryptographic library.

make all-push

Build and push all image variants of the driver needed for an official release. This target is not intended or designed to be run outside of CI.

Local Development

make or make bin/aws-ebs-csi-driver or make bin/aws-ebs-csi-driver.exe

Build a binary copy of the EBS CSI Driver for the local platform. This is the default behavior when calling make with no target.

The target OS and/or architecture can be overridden via the OS and ARCH environment variables (for example, OS=linux ARCH=arm64 make)

make test

Run all unit tests with race condition checking enabled.

make verify

Performs local verification that other than unit tests (linters, manifest updates, etc)

make update

Updates Kustomize manifests, formatting, and tidies go.mod. make verify will ensure that make update was run by checking if it creates a diff.

Cluster Management

make cluster/create

Creates a cluster for running E2E tests against. There are many parameters that can be provided via environment variables, a full list is available in config.sh, but the primary parameters are:

  • CLUSTER_TYPE: The tool used to create the cluster, either kops or eksctl - defaults to kops
  • CLUSTER_NAME: The name of the cluster to create - defaults to ebs-csi-e2e.k8s.local
  • INSTANCE_TYPE: The instance type to use for cluster nodes - defaults to c5.large
  • AMI_PARAMETER: The SSM parameter of where to get the AMI for the cluster nodes (kops clusters only) - defaults to /aws/service/ami-amazon-linux-latest/al2023-ami-kernel-default-x86_64
  • WINDOWS: Whether or not to create a Windows node group for the cluster (eksctl clusters only) - defaults to false
  • AWS_REGION: Which region to create the cluster in - defaults to us-west-2
  • AWS_AVAILABILITY_ZONES: Which AZs to create nodes for the cluster in - defaults to us-west-2a,us-west-2b,us-west-2c
  • OUTPOST_ARN: If set, create an additional nodegroup on an outpost (`eksctl clusters only)
  • OUTPOST_INSTANCE_TYPE: The instance type to use for the outpost nodegroup (only used when OUTPOST_ARN is non-empty) - defaults to INSTANCE_TYPE

Example: Create a default (kops) cluster

make cluster/create

Example: Create a cluster with only one Availability Zone

export AWS_AVAILABILITY_ZONES="us-west-2a"
make cluster/create

Example: Create an eksctl cluster

export CLUSTER_TYPE="eksctl"
make cluster/create

Example: Create a cluster with Graviton nodes for arm64 testing

export INSTANCE_TYPE="m7g.medium"
export AMI_PARAMETER="/aws/service/ami-amazon-linux-latest/al2023-ami-kernel-default-arm64"
make cluster/create

Example: Create a cluster with Windows nodes

export WINDOWS="true"
export CLUSTER_TYPE="eksctl"
make cluster/create

Example: Create a cluster with an outpost nodegroup

export CLUSTER_TYPE="eksctl"
export OUTPOST_ARN="arn:aws:outposts:us-east-1:123456789012:outpost/op-0f39f7c0af9b166a3"
export OUTPOST_INSTANCE_TYPE=c5.xlarge
make cluster/create

make cluster/image

Builds an image for use in the E2E tests. This will automatically build the most appropriate image (for example, skipping Windows builds unless WINDOWS is set to true).

Example: Build a standard image

make cluster/image

Example: Build an arm64 image

export IMAGE_ARCH="arm64"
make cluster/image

Example: Build a Windows-compatible image

export WINDOWS="true"
make cluster/image

make cluster/kubeconfig

Prints the KUBECONFIG environment variable for a cluster. You must pass the same CLUSTER_TYPE and CLUSTER_NAME as used when creating the cluster. This command must be evaled to import the environment variables into your shell.

Example: Export the KUBECONFIG for a default cluster

eval "$(make cluster/kubeconfig)"

Example: Export the KUBECONFIG for an eksctl cluster

export CLUSTER_TYPE="eksctl"
eval "$(make cluster/kubeconfig)"

make cluster/delete

Deletes a cluster created by make cluster/create. You must pass the same CLUSTER_TYPE and CLUSTER_NAME as used when creating the cluster.

make cluster/install

Install the EBS CSI Driver to the cluster via Helm. You must have already run make cluster/image to build the image for the cluster, or provide an image of your own.

Example: Install the EBS CSI Driver to a cluster for testing

make cluster/install

make cluster/uninstall

Uninstall an installation of the EBS CSI Driver previously installed by make cluster/install.

Example: Uninstall the EBS CSI Driver

make cluster/uninstall

E2E Tests

Run E2E tests against a cluster created by make cluster/create. You must pass the same CLUSTER_TYPE and CLUSTER_NAME as used when creating the cluster. You must have already run make cluster/image to build the image for the cluster, or provide an image of your own.

Alternatively, you may run on an externally created cluster by passing CLUSTER_TYPE (required to determine which values.yaml to deploy) and KUBECONFIG. For kops clusters, the node IAM role should include the appropriate IAM policies to use the driver (see the installation docs). For eksctl clusters, the ebs-csi-controller-sa service account should be pre-created and setup to supply an IRSA role with the appropriate policies.

make e2e/external

Run the Kubernetes upstream external storage E2E tests. This is the most comprehensive E2E test, recommended for local development.

make e2e/single-az

Run the single-AZ EBS CSI E2E tests. Requires a cluster with only one Availability Zone.

make e2e/multi-az

Run the multi-AZ EBS CSI E2E tests. Requires a cluster with at least two Availability Zones.

make e2e/external-windows

Run the Kubernetes upstream external storage E2E tests with Windows tests enabled. Requires a cluster with Windows nodes.

make e2e/external-kustomize

Run the Kubernetes upstream external storage E2E tests, but using kustomize to deploy the driver instead of helm.

make e2e/helm-ct

Test the EBS CSI Driver Helm chart via the Helm chart-testing tool.

Release Scripts

'make update-image-dependencies'

Convenience target to perform all image updates (including sidecars, kubekins-e2e-v2, and gcb-docker-gcloud). This is the primary target to use unless more granular control is needed.

make update-sidecar-dependencies

Convenience target to perform all sidecar updates and regenerate the manifests.

make update-truth-sidecars

Retrieves the latest sidecar container images and creates or updates hack/release-scripts/image-digests.yaml.

make generate-sidecar-tags

Updates the Kustomize and Helm sidecar tags with the values from hack/release-scripts/image-digests.yaml.