dev.galasa.kubernetes.internal.properties.KubernetesStorageClass 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. 2020.
 */
package dev.galasa.kubernetes.internal.properties;

import dev.galasa.framework.spi.ConfigurationPropertyStoreException;
import dev.galasa.framework.spi.cps.CpsProperties;
import dev.galasa.kubernetes.KubernetesManagerException;
import dev.galasa.kubernetes.internal.KubernetesClusterImpl;


/**
 * Kubernetes Override Storage Class CPS Property
 * 
 * @galasa.cps.property
 * 
 * @galasa.name kubernetes.cluster.[XXXX.]override.storageclass
 * 
 * @galasa.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*
 * 
 * @galasa.required No
 * 
 * @galasa.default None
 * 
 * @galasa.valid_values A valid StorageClass that is defined in the Kubernetes cluster
 * 
 * @galasa.examples 
 * kubernetes.cluster.K8S.override.storageclass=fast

 * kubernetes.cluster.override.storageclass=slow
 * 
 */
public class KubernetesStorageClass extends CpsProperties {

    public static String get(KubernetesClusterImpl cluster) throws KubernetesManagerException {
        try {
            return getStringNulled(KubernetesPropertiesSingleton.cps(), "cluster", "override.storageclass", cluster.getId()) ;
        } catch (ConfigurationPropertyStoreException e) {
            throw new KubernetesManagerException("Problem retrieving the storageclass override for cluster " + cluster.getId(), e);
        }
    }
}