A helper module for use in Giant Swarm E2E test frameworks to handle the creation and deletion of workload clusters to perform tests against.
Note: This should not be used as a general purpose tool to create Giant Swarm clusters and is solely designed for use in our test frameworks.
go get github.com/giantswarm/cluster-standup-teardownWhen using this module to standup a workload cluster it is expected that the E2E_KUBECONFIG environment variable is set and pointing to a valid kubeconfig with expected contexts defined.
Each ClusterBuilder in this module has a specific KubeContext that it supports and that is expected to exist in the provided KubeConfig when running.
Example kubeconfig:
apiVersion: v1
kind: Config
contexts:
- context:
cluster: glippy
user: glippy-admin
name: capz
- context:
cluster: grizzly
user: grizzly-admin
name: capa
- context:
cluster: gcapeverde
user: gcapeverde-admin
name: capv
- context:
cluster: gerbil
user: gerbil-admin
name: capvcd
clusters:
- cluster:
certificate-authority-data: [REDACTED]
server: https://[REDACTED]:6443
name: glippy
- cluster:
certificate-authority-data: [REDACTED]
server: https://[REDACTED]:6443
name: grizzly
- cluster:
certificate-authority-data: [REDACTED]
server: https://[REDACTED]:6443
name: gcapeverde
- cluster:
certificate-authority-data: [REDACTED]
server: https://[REDACTED]:6443
name: gerbil
current-context: grizzly
preferences: {}
users:
- name: glippy-admin
user:
client-certificate-data: [REDACTED]
client-key-data: [REDACTED]
- name: grizzly-admin
user:
client-certificate-data: [REDACTED]
client-key-data: [REDACTED]
- name: gcapeverde-admin
user:
client-certificate-data: [REDACTED]
client-key-data: [REDACTED]
- name: gerbil-admin
user:
client-certificate-data: [REDACTED]
client-key-data: [REDACTED]Documentation can be found at: pkg.go.dev/github.com/giantswarm/cluster-standup-teardown.
Create a workload cluster using the same known-good configuration as the E2E test suites.
Once the workload cluster is ready two files will be produced:
- a
kubeconfigto use to access the cluster - a
results.jsonthat contains details about the cluster created and can be used byteardownto cleanup the cluster when done
go install github.com/giantswarm/cluster-standup-teardown/cmd/standup@latest$ standup --help
Standup create a test workload cluster in a standard, reproducible way.
A valid Management Cluster kubeconfig must be available and set to the `E2E_KUBECONFIG` environment variable.
Usage:
standup [flags]
Examples:
standup --provider aws --context capa
Flags:
--cluster-values string The path to the cluster app values
--cluster-version string The version of the cluster app to install (default "latest")
--context string The kubernetes context to use (required)
--control-plane-nodes int The number of control plane nodes to wait for being ready (default 1)
--default-apps-values string The path to the default-apps app values
--default-apps-version string The version of the default-apps app to install (default "latest")
-h, --help help for standup
--output string The directory to store the results.json and kubeconfig in (default "./")
--provider string The provider (required)
--worker-nodes int The number of worker nodes to wait for being ready (default 1)
export E2E_KUBECONFIG=/path/to/kubeconfig
standup --provider aws --context capa
Cleans up a workload cluster previously created by standup. Makes use of the kubeconfig and results.json produced by standup.
go install github.com/giantswarm/cluster-standup-teardown/cmd/teardown@latest$ teardown --help
Teardown completely removes a previously created test cluster.
Can take in the results.json produced by `standup` to quickly clean up a test cluster.
A valid Management Cluster kubeconfig must be available and set to the `E2E_KUBECONFIG` environment variable.
Usage:
teardown [flags]
Examples:
teardown --context capa --standup-directory ./
Flags:
--cleanup-standup-results Remove the results and kubeconfig generated by 'standup' (default true)
--cluster-name string The name of the cluster to tear down
--context string The kubernetes context to use (required)
-h, --help help for teardown
--org-name string The org the cluster belongs to
--provider string The provider
--standup-directory string The directory containing the results from 'standup'
teardown --provider aws --context capa --standup-directory ./
![renovate[bot]](https://avatars.githubusercontent.com/u/29139614?size=120)
