galasa

Close menu
Open menu

Kubernetes Manager

ALPHA - This Manager is being actively developed. It is subject to change and has not been extensively tested.

Overview

This Manager provides a test with a Kubernetes Namespace to utilize. The test will provide YAML representations of the resources that the test requires.

As an absolute minimum, the CPS property kubernetes.cluster.K8S.url must be provided as well as a credential secure.credentials.K8S.token for the API token.

The Kubernetes Manager supports Galasa Shared Environments. Shared environments provide the ability to create a test environment that can be shared across multiple test runs so you don't have to provision a test environment for each test.

Limitations

The Manager only supports the following Kubernetes resources:-

- Deployment
- StatefulSet
- Service
- Secret
- ConfigMap
- PersistentVolumeClaim

If additional resources are required, please raise a GitHub issue.

You can view the Javadoc documentation for the Manager here.

Annotations

The following annotations are available with the Kubernetes Manager

Kubernetes Namespace
Annotation: Kubernetes Namespace
Name: @KubernetesNamespace
Description: The @KubernetesNamespace annotation requests the Kubernetes Manager to allocate a namespace on the infrastructure Kubernetes clusters. The test can request as many namespaces as required so long as they can be supported simultaneously by the Kubernetes Manager configuration.
Attribute: kubernetesNamespaceTag The kubernetesNamespaceTag identifies the Kubernetes names to other Managers or Shared Environments. If a test is using multiple Kubernetes namespace, each separate Kubernetes namespace must have a unique tag. If more than one Kubernetes namespace use the same tag, they will refer to the same Kubernetes namespace.
Syntax: @KubernetesNamespace
public IKubernetesNamesapce namespace;
Notes: The IKubernetesNamespace interface gives the test access to create and manage resources on the Kubernetes cluster. See KubernetesNamespace and IKubernetesNamespace to find out more.

Code snippets

Use the following code snippets to help you get started with the Kubernetes Manager.

Create Kubernetes namespaces for the Kubernetes Manager to use

Note: Isolated namespaces must be provided for the Kubernetes Manager to use. The Manager deletes any resources that exist on the namespace once a test has finished.

The following are example scripts and yaml files necessary to create namespaces:

  1. Namespace creation script
  2. Create Service Account for the Manager to use (including api token)
  3. The RBAC rules to be applied to each namespace

Obtain a Kubernetes Namespace
@KubernetesNamespace()
public IKubernetesNamespace namespace;

This code requests the Kubernetes Manager to allocate a namespace for the test to use.

There is no limit in Galasa on how many Kubernetes Namespaces can be used within a single test. The only limit is the number of Kubernetes Namespaces that can be started in the Galasa Ecosystem. This limit is set by the Galasa Administrator and is typically set to the maximum number of namespaces defined in the Kubernetes cluster. If there are not enough slots available for an automated run, the run is put back on the queue in waiting state to retry. Local test runs fail if there are not enough container slots available.

Create a resource on the namespace
@ArtifactManager
public IArtifactManager artifactManager

@KubernetesNamespace()
public IKubernetesNamespace namespace;

@Test
public void test() {
	IBundleResources bundleResources = artifactManager.getBundleResources(getClass());
	
	String yaml = bundleResource.streamAsString(bundleResources.retrieveFile("/example.yaml"));
	
	IResource resource = namespace.createResource(yaml);
}

In this snippet, the test retrieves the contents of the /example.yaml resource file as a String. The yaml file is passed the namespace for creation. The yaml must contain only one Kubernetes resource.

The resource is created but is not checked to see if the resource has been started or allocated.

Retrieve a pod log
IStatefulSet statefulSet = (IStatefulSet)namespace.createResource(yaml);

List<IPodLog> podLogs = statefulSet.getPodLogs("containername");

As Deployments and StatefulSets can have multiple pods and therefore containers with the same name, a List is returned containing all the current logs for all the named containers.

Configuration Properties

The following are properties used to configure the Kubernetes Manager.

Kubernetes Cluster IDs CPS Property
Property: Kubernetes Cluster IDs CPS Property
Name: kubernetes.cluster.ids
Description: Provides a comma separated list of the active Kubernetes Clusters that are defined in the CPS
Required: No
Default value: Defaults to a single cluster ID of K8S if the property is missing
Valid values: A comma separated list of alphanumeric IDs. Normally uppercased.
Examples: kubernetes.cluster.ids=K8S,ALTERNATE
Kubernetes Cluster Credentials CPS Property
Property: Kubernetes Cluster Credentials CPS Property
Name: kubernetes.cluster.[XXXX.]credentials
Description: Provides the Credentials ID for the token required to access the Kubernetes cluster
Required: No
Default value: K8S
Valid values: A valid credentials ID. Galasa convention states IDs should be uppercase
Examples: kubernetes.cluster.K8S.credentials=K8S
kubernetes.cluster.credentials=K8S
Maximum Slots on Cluster CPS Property
Property: Maximum Slots on Cluster CPS Property
Name: kubernetes.cluster.[XXXX.]max.slots
Description: Specifies the maximum number of slots(namespaces) that can be allocated at one time on the cluster
Required: No
Default value: Defaults to 2 if not provided
Valid values: Integer value. A value <0 disables the cluster.
Examples: kubernetes.cluster.K8S.max.slots=5
Kubernetes Tag Shared Environment
Property: Kubernetes Tag Shared Environment
Name: kubernetes.namespace.tag.XXXXXX.shared.environment
Description: Tells the Kubernetes Manager which Shared Environment is assigned to a namespace tag
Required: No
Default value: None
Valid values: A valid Shared Environment
Examples: kubernetes.namespace.tag.SHARED.shared.environment=M1
Kubernetes Namespace IDs CPS Property
Property: Kubernetes Namespace IDs CPS Property
Name: kubernetes.cluster.[XXXX.]namespaces
Description: Provides a comma separated list of the namespaces that are available on the cluster
Required: No
Default value: Defaults to galasa{1-2} if not provided
Valid values: A comma separated list of valid Kubernetes namespaces with resource pooling expanders
Examples: kubernetes.cluster.K8S.namespaces=galasa1,galasa{2-9}
kubebernetes.cluster.namespaces=bob1,bob2,bob3
Kubernetes Node Port Proxy Hostname CPS Property
Property: Kubernetes Node Port Proxy Hostname CPS Property
Name: kubernetes.cluster.XXXX.nodeport.proxy.hostname
Description: Provides the hostname that NodePorts can be accessed on.
Required: No
Default value: The hostname as specified in the API URL
Valid values: A valid URL hostname
Examples: kubernetes.cluster.K8S.nodeport.proxy.hostname=cluster.org
Kubernetes Override Storage Class CPS Property
Property: Kubernetes Override Storage Class CPS Property
Name: kubernetes.cluster.[XXXX.]override.storageclass
Description: Provides a Kubernetes StorageClass that is set on all PersistentVolumeClaims that are created in the Kubernetes namespace. The value of this property is set in the property spec.storageClassName
Required: No
Default value: None
Valid values: A valid StorageClass that is defined in the Kubernetes cluster
Examples: kubernetes.cluster.K8S.override.storageclass=fast
kubernetes.cluster.override.storageclass=slow
Kubernetes Cluster API URL CPS Property
Property: Kubernetes Cluster API URL CPS Property
Name: kubernetes.cluster.XXXX.url
Description: The API URL of the Kubernetes Cluster
Required: Yes
Default value: None
Valid values: A valid URL
Examples: kubernetes.cluster.K8S.url=http://cluster.org:8443
Kubernetes Validate Cluster Certificate CPS Property
Property: Kubernetes Validate Cluster Certificate CPS Property
Name: kubernetes.cluster.[XXXX.]validate.certificate
Description: Validates the Kubernetes Cluster API Certificate
Required: No
Default value: true
Valid values: true or false
Examples: kubernetes.cluster.K8S.validate.certificate=false
kubernetes.cluster.validate.certificate=true