dev.galasa.kubernetes.KubernetesNamespace Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dev.galasa.kubernetes.manager Show documentation

There is a newer version: 0.34.0

Show newest version

/*
 * Licensed Materials - Property of IBM
 * 
 * (c) Copyright IBM Corp. 2019.
 */
package dev.galasa.kubernetes;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import dev.galasa.framework.spi.ValidAnnotatedFields;
import dev.galasa.kubernetes.internal.KubernetesManagerField;

/**
 * Kubernetes Namespace
 * 
 * @galasa.annotation
 * 
 * @galasa.description The {@literal @}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.
 * 
 * @galasa.examples 
 * {@literal @}KubernetesNamespace

 * public IKubernetesNamesapce namespace;

 * 
 * 
 * @galasa.extra
 * The IKubernetesNamespace interface gives the test access to create and manage resources on the Kubernetes cluster. 
 * See {@link KubernetesNamespace} and {@link IKubernetesNamespace} to find out more.
 * 
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.FIELD })
@ValidAnnotatedFields({ IKubernetesNamespace.class })
@KubernetesManagerField
public @interface KubernetesNamespace {

    /**
     * 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.
     */
    public String kubernetesNamespaceTag() default "PRIMARY";
}