diff --git a/api-frontend/Dockerfile b/api-frontend/Dockerfile index 3bd771b38c..ba8906f818 100644 --- a/api-frontend/Dockerfile +++ b/api-frontend/Dockerfile @@ -1,4 +1,4 @@ -FROM openjdk:8u131-jre-alpine +FROM openjdk:8u171-jre-alpine3.7 ARG APP_VERSION=UNKOWN_VERSION diff --git a/api-frontend/pom.xml b/api-frontend/pom.xml index f59b939e5c..05db366f5b 100644 --- a/api-frontend/pom.xml +++ b/api-frontend/pom.xml @@ -10,7 +10,7 @@ io.seldon.apife seldon-apife - 0.2.1-SNAPSHOT + 0.2.1-SNAPSHOT-CRD jar api-frontend diff --git a/cluster-manager/Dockerfile b/cluster-manager/Dockerfile index 37be350adb..bbc145cc6a 100644 --- a/cluster-manager/Dockerfile +++ b/cluster-manager/Dockerfile @@ -1,4 +1,4 @@ -FROM openjdk:8u131-jre-alpine +FROM openjdk:8u171-jre-alpine3.7 ARG APP_VERSION=UNKOWN_VERSION diff --git a/cluster-manager/README.txt b/cluster-manager/README.txt index bea5f9a39e..9a098f4fb0 100644 --- a/cluster-manager/README.txt +++ b/cluster-manager/README.txt @@ -1,4 +1,4 @@ Local testing: export SELDON_CLUSTER_MANAGER_POD_NAMESPACE=seldon -export ENGINE_CONTAINER_IMAGE_AND_VERSION=seldonio/engine:0.1.8-SNAPSHOT +export ENGINE_CONTAINER_IMAGE_AND_VERSION=seldonio/engine: diff --git a/cluster-manager/pom.xml b/cluster-manager/pom.xml index 22a2a89b54..4cf71b05ba 100644 --- a/cluster-manager/pom.xml +++ b/cluster-manager/pom.xml @@ -4,7 +4,7 @@ io.seldon.clustermanager seldon-cluster-manager jar - 0.2.1-SNAPSHOT + 0.2.1-SNAPSHOT-CRD seldon-cluster-manager http://maven.apache.org diff --git a/cluster-manager/src/main/java/io/seldon/clustermanager/k8s/CRDCreator.java b/cluster-manager/src/main/java/io/seldon/clustermanager/k8s/CRDCreator.java new file mode 100644 index 0000000000..a283419cad --- /dev/null +++ b/cluster-manager/src/main/java/io/seldon/clustermanager/k8s/CRDCreator.java @@ -0,0 +1,140 @@ +package io.seldon.clustermanager.k8s; + +import java.io.BufferedReader; +import java.io.IOException; +import java.io.InputStream; +import java.io.InputStreamReader; +import java.lang.reflect.Type; +import java.nio.charset.Charset; +import java.nio.charset.StandardCharsets; +import java.nio.file.Files; +import java.nio.file.Paths; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import com.google.gson.reflect.TypeToken; + +import io.kubernetes.client.ApiClient; +import io.kubernetes.client.ApiException; +import io.kubernetes.client.ApiResponse; +import io.kubernetes.client.Pair; +import io.kubernetes.client.ProgressRequestBody; +import io.kubernetes.client.ProgressResponseBody; +import io.kubernetes.client.models.V1beta1CustomResourceDefinition; +import io.kubernetes.client.util.Config; + +public class CRDCreator { + protected static Logger logger = LoggerFactory.getLogger(CRDCreator.class.getName()); + public void createCRD() throws IOException, ApiException + { + String jsonStr = readFileFromClasspath("crd.json"); + ApiClient client = Config.defaultClient(); + try { + createCustomResourceDefinition(client,jsonStr.getBytes(),null); + logger.info("Created CRD"); + } catch (ApiException e) { + if (e.getCode() == 409)// CRD Already Exists + { + logger.info("CRD already exists - ignoring."); + } + else if (e.getCode() == 403)// Forbidden - Maybe CRD exists, but we don't know + { + logger.warn("No auth to create CRD. Hopefully, one exists.",e); // Hopefully a cluster-wide CRD has been created for us + } + else + { + logger.warn("Unexpected error trying to create CRD",e); + throw e; + } + } + } + private String readFromInputStream(InputStream inputStream) + throws IOException { + StringBuilder resultStringBuilder = new StringBuilder(); + try (BufferedReader br + = new BufferedReader(new InputStreamReader(inputStream))) { + String line; + while ((line = br.readLine()) != null) { + resultStringBuilder.append(line).append("\n"); + } + } + return resultStringBuilder.toString(); + } + private String readFileFromClasspath(String name) throws IOException + { + InputStream in = this.getClass().getClassLoader().getResourceAsStream(name); + String data = readFromInputStream(in); + return data; + } + + private String readFile(String path, Charset encoding) + throws IOException + { + byte[] encoded = Files.readAllBytes(Paths.get(path)); + return new String(encoded, encoding); + } + + private V1beta1CustomResourceDefinition createCustomResourceDefinition(ApiClient apiClient,byte[] body, String pretty) + throws ApiException { + ApiResponse resp = createCustomResourceDefinitionWithHttpInfo(apiClient,body, pretty); + return resp.getData(); + } + + private ApiResponse createCustomResourceDefinitionWithHttpInfo(ApiClient apiClient,byte[] body, + String pretty) throws ApiException { + com.squareup.okhttp.Call call = createCustomResourceDefinitionCall(apiClient,body, pretty, null, null); + Type localVarReturnType = new TypeToken() { + }.getType(); + return apiClient.execute(call, localVarReturnType); + } + + public com.squareup.okhttp.Call createCustomResourceDefinitionCall(ApiClient apiClient,byte[] body, String pretty, + final ProgressResponseBody.ProgressListener progressListener, + final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + Object localVarPostBody = body; + + // create path and map variables + String localVarPath = "/apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions"; + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + if (pretty != null) + localVarQueryParams.addAll(apiClient.parameterToPair("pretty", pretty)); + + Map localVarHeaderParams = new HashMap(); + + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { "application/json", "application/yaml", + "application/vnd.kubernetes.protobuf" }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) + localVarHeaderParams.put("Accept", localVarAccept); + + final String[] localVarContentTypes = { "*/*" }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + if (progressListener != null) { + apiClient.getHttpClient().networkInterceptors().add(new com.squareup.okhttp.Interceptor() { + @Override + public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Chain chain) + throws IOException { + com.squareup.okhttp.Response originalResponse = chain.proceed(chain.request()); + return originalResponse.newBuilder() + .body(new ProgressResponseBody(originalResponse.body(), progressListener)).build(); + } + }); + } + + String[] localVarAuthNames = new String[] { "BearerToken" }; + return apiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, + localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, progressRequestListener); + } + +} diff --git a/cluster-manager/src/main/java/io/seldon/clustermanager/k8s/SeldonDeploymentControllerImpl.java b/cluster-manager/src/main/java/io/seldon/clustermanager/k8s/SeldonDeploymentControllerImpl.java index 638a4a81ae..a4ea766a15 100644 --- a/cluster-manager/src/main/java/io/seldon/clustermanager/k8s/SeldonDeploymentControllerImpl.java +++ b/cluster-manager/src/main/java/io/seldon/clustermanager/k8s/SeldonDeploymentControllerImpl.java @@ -26,13 +26,16 @@ import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Component; +import io.kubernetes.client.ApiClient; import io.kubernetes.client.ApiException; import io.kubernetes.client.ProtoClient; import io.kubernetes.client.ProtoClient.ObjectOrStatus; +import io.kubernetes.client.apis.CoreV1Api; import io.kubernetes.client.models.ExtensionsV1beta1Deployment; import io.kubernetes.client.models.ExtensionsV1beta1DeploymentList; import io.kubernetes.client.models.V1Service; import io.kubernetes.client.models.V1ServiceList; +import io.kubernetes.client.models.V1Status; import io.kubernetes.client.proto.Meta.DeleteOptions; import io.kubernetes.client.proto.V1.Service; import io.kubernetes.client.proto.V1beta1Extensions.Deployment; @@ -139,6 +142,38 @@ private void removeDeployments(ProtoClient client,String namespace,SeldonDeploym } } + private void removeServices(ApiClient client,String namespace,SeldonDeployment seldonDeployment,List services) throws ApiException, IOException, SeldonDeploymentException + { + Set names = getServiceNames(services); + V1ServiceList svcList = crdHandler.getOwnedServices(seldonDeployment.getSpec().getName()); + for(V1Service s : svcList.getItems()) + { + if (!names.contains(s.getMetadata().getName())) + { + CoreV1Api api = new CoreV1Api(client); + V1Status status = api.deleteNamespacedService(s.getMetadata().getName(), namespace, null); + if (!"Success".equals(status.getStatus())) + { + logger.error("Failed to delete service "+s.getMetadata().getName()); + throw new SeldonDeploymentException("Failed to delete service "+s.getMetadata().getName()); + } + else + logger.debug("Deleted deployment "+s.getMetadata().getName()); + + } + } + } + + /** + * Currently Not used as issue with proto client needs further investigation + * @param client + * @param namespace + * @param seldonDeployment + * @param services + * @throws ApiException + * @throws IOException + * @throws SeldonDeploymentException + */ private void removeServices(ProtoClient client,String namespace,SeldonDeployment seldonDeployment,List services) throws ApiException, IOException, SeldonDeploymentException { Set names = getServiceNames(services); @@ -151,9 +186,9 @@ private void removeServices(ProtoClient client,String namespace,SeldonDeployment .replaceAll("\\{" + "name" + "\\}", client.getApiClient().escapeString(s.getMetadata().getName())) .replaceAll("\\{" + "namespace" + "\\}", client.getApiClient().escapeString(namespace)); DeleteOptions options = DeleteOptions.newBuilder().setPropagationPolicy("Foreground").build(); - ObjectOrStatus os = client.delete(Deployment.newBuilder(),deleteApiPath,options); + ObjectOrStatus os = client.delete(Service.newBuilder(),deleteApiPath,options); if (os.status != null) { - logger.error("Error deleting deployment:"+ProtoBufUtils.toJson(os.status)); + logger.error("Error deleting service:"+ProtoBufUtils.toJson(os.status)); throw new SeldonDeploymentException("Failed to delete service "+s.getMetadata().getName()); } else { @@ -245,7 +280,9 @@ public void createOrReplaceSeldonDeployment(SeldonDeployment mlDep) { createDeployments(client, namespace, resources.deployments); removeDeployments(client, namespace, mlDep2, resources.deployments); createServices(client, namespace, resources.services); - removeServices(client,namespace, mlDep2, resources.services); + //removeServices(client,namespace, mlDep2, resources.services); //Proto Client not presently working for deletion + ApiClient client2 = clientProvider.getClient(); + removeServices(client2,namespace, mlDep2, resources.services); if (!mlDep.getSpec().equals(mlDep2.getSpec())) { logger.debug("Pushing updated SeldonDeployment "+mlDep2.getMetadata().getName()+" back to kubectl"); diff --git a/cluster-manager/src/main/java/io/seldon/clustermanager/k8s/SeldonDeploymentOperatorImpl.java b/cluster-manager/src/main/java/io/seldon/clustermanager/k8s/SeldonDeploymentOperatorImpl.java index 3d4fd0afda..bb0cc3abcd 100644 --- a/cluster-manager/src/main/java/io/seldon/clustermanager/k8s/SeldonDeploymentOperatorImpl.java +++ b/cluster-manager/src/main/java/io/seldon/clustermanager/k8s/SeldonDeploymentOperatorImpl.java @@ -45,6 +45,7 @@ import io.kubernetes.client.proto.V1.HTTPGetAction; import io.kubernetes.client.proto.V1.Handler; import io.kubernetes.client.proto.V1.Lifecycle; +import io.kubernetes.client.proto.V1.PodSecurityContext; import io.kubernetes.client.proto.V1.PodTemplateSpec; import io.kubernetes.client.proto.V1.Probe; import io.kubernetes.client.proto.V1.Service; @@ -531,7 +532,9 @@ public DeploymentResources createResources(SeldonDeployment mlDep) throws Seldon PodTemplateSpec.Builder podSpecBuilder = PodTemplateSpec.newBuilder(); podSpecBuilder.getSpecBuilder() .addContainers(createEngineContainer(mlDep,p)) + .setSecurityContext(PodSecurityContext.newBuilder().setRunAsUser(8888).build()) .setTerminationGracePeriodSeconds(20); + String depName = getSeldonServiceName(mlDep,p,"svc-orch"); podSpecBuilder.getMetadataBuilder() .putLabels(LABEL_SELDON_APP, mlDep.getSpec().getName()) diff --git a/cluster-manager/src/main/java/io/seldon/clustermanager/k8s/SeldonDeploymentWatcher.java b/cluster-manager/src/main/java/io/seldon/clustermanager/k8s/SeldonDeploymentWatcher.java index 16a4d64f88..9923ac64d5 100644 --- a/cluster-manager/src/main/java/io/seldon/clustermanager/k8s/SeldonDeploymentWatcher.java +++ b/cluster-manager/src/main/java/io/seldon/clustermanager/k8s/SeldonDeploymentWatcher.java @@ -57,11 +57,13 @@ public class SeldonDeploymentWatcher { private int resourceVersionProcessed = 0; @Autowired - public SeldonDeploymentWatcher(ClusterManagerProperites clusterManagerProperites,SeldonDeploymentController seldonDeploymentController,SeldonDeploymentCache mlCache) throws IOException + public SeldonDeploymentWatcher(ClusterManagerProperites clusterManagerProperites,SeldonDeploymentController seldonDeploymentController,SeldonDeploymentCache mlCache) throws IOException, ApiException { this.seldonDeploymentController = seldonDeploymentController; this.mlCache = mlCache; this.clusterManagerProperites = clusterManagerProperites; + CRDCreator crdCreator = new CRDCreator(); + crdCreator.createCRD(); } private void processWatch(SeldonDeployment mldep,String action) throws InvalidProtocolBufferException diff --git a/cluster-manager/src/main/resources/crd.json b/cluster-manager/src/main/resources/crd.json new file mode 100644 index 0000000000..0c8a4667e9 --- /dev/null +++ b/cluster-manager/src/main/resources/crd.json @@ -0,0 +1,3586 @@ +{ + + + "metadata": { + "name": "seldondeployments.machinelearning.seldon.io" + }, + "spec": { + "group": "machinelearning.seldon.io", + "names": { + "kind": "SeldonDeployment", + "plural": "seldondeployments", + "shortNames": [ + "sdep" + ], + "singular": "seldondeployment" + }, + "scope": "Namespaced", + "validation": { + "openAPIV3Schema": { + "properties": { + "spec": { + "properties": { + "annotations": { + "description": "The annotations to be updated to a deployment", + "type": "object" + }, + "name": { + "type": "string" + }, + "oauth_key": { + "type": "string" + }, + "oauth_secret": { + "type": "string" + }, + "predictors": { + "description": "List of predictors belonging to the deployment", + "items": { + "properties": { + "annotations": { + "description": "The annotations to be updated to a predictor", + "type": "object" + }, + "graph": { + "properties": { + "children": { + "items": { + "properties": { + "children": { + "items": { + "properties": { + "children": { + "items": {}, + "type": "array" + }, + "endpoint": { + "properties": { + "service_host": { + "type": "string" + }, + "service_port": { + "type": "integer" + }, + "type": { + "enum": [ + "REST", + "GRPC" + ], + "type": "string" + } + } + }, + "name": { + "type": "string" + }, + "implementation": { + "enum": [ + "UNKNOWN_IMPLEMENTATION", + "SIMPLE_MODEL", + "SIMPLE_ROUTER", + "RANDOM_ABTEST", + "AVERAGE_COMBINER" + ], + "type": "string" + }, + "type": { + "enum": [ + "UNKNOWN_TYPE", + "ROUTER", + "COMBINER", + "MODEL", + "TRANSFORMER", + "OUTPUT_TRANSFORMER" + ], + "type": "string" + }, + "methods": { + "type":"array", + "items":{ + "enum": [ + "TRANSFORM_INPUT", + "TRANSFORM_OUTPUT", + "ROUTE", + "AGGREGATE", + "SEND_FEEDBACK"], + "type": "string" + } + } + } + }, + "type": "array" + }, + "endpoint": { + "properties": { + "service_host": { + "type": "string" + }, + "service_port": { + "type": "integer" + }, + "type": { + "enum": [ + "REST", + "GRPC" + ], + "type": "string" + } + } + }, + "name": { + "type": "string" + }, + "implementation": { + "enum": [ + "UNKNOWN_IMPLEMENTATION", + "SIMPLE_MODEL", + "SIMPLE_ROUTER", + "RANDOM_ABTEST", + "AVERAGE_COMBINER" + ], + "type": "string" + }, + "type": { + "enum": [ + "UNKNOWN_TYPE", + "ROUTER", + "COMBINER", + "MODEL", + "TRANSFORMER", + "OUTPUT_TRANSFORMER" + ], + "type": "string" + }, + "methods": { + "type":"array", + "items":{ + "enum": [ + "TRANSFORM_INPUT", + "TRANSFORM_OUTPUT", + "ROUTE", + "AGGREGATE", + "SEND_FEEDBACK"], + "type": "string" + } + } + } + }, + "type": "array" + }, + "endpoint": { + "properties": { + "service_host": { + "type": "string" + }, + "service_port": { + "type": "integer" + }, + "type": { + "enum": [ + "REST", + "GRPC" + ], + "type": "string" + } + } + }, + "name": { + "type": "string" + }, + "implementation": { + "enum": [ + "UNKNOWN_IMPLEMENTATION", + "SIMPLE_MODEL", + "SIMPLE_ROUTER", + "RANDOM_ABTEST", + "AVERAGE_COMBINER" + ], + "type": "string" + }, + "type": { + "enum": [ + "UNKNOWN_TYPE", + "ROUTER", + "COMBINER", + "MODEL", + "TRANSFORMER", + "OUTPUT_TRANSFORMER" + ], + "type": "string" + }, + "methods": { + "type":"array", + "items":{ + "enum": [ + "TRANSFORM_INPUT", + "TRANSFORM_OUTPUT", + "ROUTE", + "AGGREGATE", + "SEND_FEEDBACK"], + "type": "string" + } + } + } + }, + "name": { + "type": "string" + }, + "replicas": { + "type": "integer" + } + } + }, + "type": "array" + }, + "componentSpecs": + { + "description": "List of pods belonging to the predictor", + "type" : "array", + "items": +{ + "description": "PodTemplateSpec describes the data a pod should have when created from a template", + "properties": { + "spec": { + "required": [ + "containers" + ], + "description": "PodSpec is a description of a pod.", + "properties": { + "dnsPolicy": { + "type": "string", + "description": "Set DNS policy for the pod. Defaults to \"ClusterFirst\". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'. Note that 'None' policy is an alpha feature introduced in v1.9 and CustomPodDNS feature gate must be enabled to use it." + }, + "hostNetwork": { + "type": "boolean", + "description": "Host networking requested for this pod. Use the host's network namespace. If this option is set, the ports that will be used must be specified. Default to false." + }, + "restartPolicy": { + "type": "string", + "description": "Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy" + }, + "automountServiceAccountToken": { + "type": "boolean", + "description": "AutomountServiceAccountToken indicates whether a service account token should be automatically mounted." + }, + "priorityClassName": { + "type": "string", + "description": "If specified, indicates the pod's priority. \"SYSTEM\" is a special keyword which indicates the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default." + }, + "securityContext": { + "description": "PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.", + "properties": { + "runAsNonRoot": { + "type": "boolean", + "description": "Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence." + }, + "fsGroup": { + "type": "integer", + "description": "A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:\n\n1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw----\n\nIf unset, the Kubelet will not modify the ownership and permissions of any volume.", + "format": "int64" + }, + "seLinuxOptions": { + "description": "SELinuxOptions are the labels to be applied to the container", + "properties": { + "type": { + "type": "string", + "description": "Type is a SELinux type label that applies to the container." + }, + "role": { + "type": "string", + "description": "Role is a SELinux role label that applies to the container." + }, + "user": { + "type": "string", + "description": "User is a SELinux user label that applies to the container." + }, + "level": { + "type": "string", + "description": "Level is SELinux level label that applies to the container." + } + } + }, + "supplementalGroups": { + "items": { + "type": "integer", + "format": "int64" + }, + "type": "array", + "description": "A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container." + }, + "runAsUser": { + "type": "integer", + "description": "The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.", + "format": "int64" + } + } + }, + "nodeName": { + "type": "string", + "description": "NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements." + }, + "hostAliases": { + "items": { + "description": "HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file.", + "properties": { + "ip": { + "type": "string", + "description": "IP address of the host file entry." + }, + "hostnames": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Hostnames for the above IP address." + } + } + }, + "type": "array", + "description": "HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified. This is only valid for non-hostNetwork pods.", + "x-kubernetes-patch-strategy": "merge", + "x-kubernetes-patch-merge-key": "ip" + }, + "hostname": { + "type": "string", + "description": "Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value." + }, + "serviceAccount": { + "type": "string", + "description": "DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead." + }, + "nodeSelector": { + "additionalProperties": true, + "type": "object", + "description": "NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/" + }, + "priority": { + "type": "integer", + "description": "The priority value. Various system components use this field to find the priority of the pod. When Priority Admission Controller is enabled, it prevents users from setting this field. The admission controller populates this field from PriorityClassName. The higher the value, the higher the priority.", + "format": "int32" + }, + "affinity": { + "description": "Affinity is a group of affinity scheduling rules.", + "properties": { + "podAffinity": { + "description": "Pod affinity is a group of inter pod affinity scheduling rules.", + "properties": { + "requiredDuringSchedulingIgnoredDuringExecution": { + "items": { + "required": [ + "topologyKey" + ], + "description": "Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running", + "properties": { + "labelSelector": { + "description": "A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.", + "properties": { + "matchLabels": { + "additionalProperties": true, + "type": "object", + "description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + }, + "matchExpressions": { + "items": { + "required": [ + "key", + "operator" + ], + "description": "A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.", + "properties": { + "operator": { + "type": "string", + "description": "operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist." + }, + "values": { + "items": { + "type": "string" + }, + "type": "array", + "description": "values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch." + }, + "key": { + "x-kubernetes-patch-merge-key": "key", + "type": "string", + "description": "key is the label key that the selector applies to.", + "x-kubernetes-patch-strategy": "merge" + } + } + }, + "type": "array", + "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed." + } + } + }, + "namespaces": { + "items": { + "type": "string" + }, + "type": "array", + "description": "namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means \"this pod's namespace\"" + }, + "topologyKey": { + "type": "string", + "description": "This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed." + } + } + }, + "type": "array", + "description": "If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied." + }, + "preferredDuringSchedulingIgnoredDuringExecution": { + "items": { + "required": [ + "weight", + "podAffinityTerm" + ], + "description": "The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)", + "properties": { + "podAffinityTerm": { + "required": [ + "topologyKey" + ], + "description": "Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running", + "properties": { + "labelSelector": { + "description": "A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.", + "properties": { + "matchLabels": { + "additionalProperties": true, + "type": "object", + "description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + }, + "matchExpressions": { + "items": { + "required": [ + "key", + "operator" + ], + "description": "A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.", + "properties": { + "operator": { + "type": "string", + "description": "operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist." + }, + "values": { + "items": { + "type": "string" + }, + "type": "array", + "description": "values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch." + }, + "key": { + "x-kubernetes-patch-merge-key": "key", + "type": "string", + "description": "key is the label key that the selector applies to.", + "x-kubernetes-patch-strategy": "merge" + } + } + }, + "type": "array", + "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed." + } + } + }, + "namespaces": { + "items": { + "type": "string" + }, + "type": "array", + "description": "namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means \"this pod's namespace\"" + }, + "topologyKey": { + "type": "string", + "description": "This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed." + } + } + }, + "weight": { + "type": "integer", + "description": "weight associated with matching the corresponding podAffinityTerm, in the range 1-100.", + "format": "int32" + } + } + }, + "type": "array", + "description": "The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred." + } + } + }, + "nodeAffinity": { + "description": "Node affinity is a group of node affinity scheduling rules.", + "properties": { + "requiredDuringSchedulingIgnoredDuringExecution": { + "required": [ + "nodeSelectorTerms" + ], + "description": "A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms.", + "properties": { + "nodeSelectorTerms": { + "items": { + "required": [ + "matchExpressions" + ], + "description": "A null or empty node selector term matches no objects.", + "properties": { + "matchExpressions": { + "items": { + "required": [ + "key", + "operator" + ], + "description": "A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.", + "properties": { + "operator": { + "type": "string", + "description": "Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt." + }, + "values": { + "items": { + "type": "string" + }, + "type": "array", + "description": "An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch." + }, + "key": { + "type": "string", + "description": "The label key that the selector applies to." + } + } + }, + "type": "array", + "description": "Required. A list of node selector requirements. The requirements are ANDed." + } + } + }, + "type": "array", + "description": "Required. A list of node selector terms. The terms are ORed." + } + } + }, + "preferredDuringSchedulingIgnoredDuringExecution": { + "items": { + "required": [ + "weight", + "preference" + ], + "description": "An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).", + "properties": { + "preference": { + "required": [ + "matchExpressions" + ], + "description": "A null or empty node selector term matches no objects.", + "properties": { + "matchExpressions": { + "items": { + "required": [ + "key", + "operator" + ], + "description": "A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.", + "properties": { + "operator": { + "type": "string", + "description": "Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt." + }, + "values": { + "items": { + "type": "string" + }, + "type": "array", + "description": "An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch." + }, + "key": { + "type": "string", + "description": "The label key that the selector applies to." + } + } + }, + "type": "array", + "description": "Required. A list of node selector requirements. The requirements are ANDed." + } + } + }, + "weight": { + "type": "integer", + "description": "Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.", + "format": "int32" + } + } + }, + "type": "array", + "description": "The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred." + } + } + }, + "podAntiAffinity": { + "description": "Pod anti affinity is a group of inter pod anti affinity scheduling rules.", + "properties": { + "requiredDuringSchedulingIgnoredDuringExecution": { + "items": { + "required": [ + "topologyKey" + ], + "description": "Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running", + "properties": { + "labelSelector": { + "description": "A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.", + "properties": { + "matchLabels": { + "additionalProperties": true, + "type": "object", + "description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + }, + "matchExpressions": { + "items": { + "required": [ + "key", + "operator" + ], + "description": "A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.", + "properties": { + "operator": { + "type": "string", + "description": "operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist." + }, + "values": { + "items": { + "type": "string" + }, + "type": "array", + "description": "values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch." + }, + "key": { + "x-kubernetes-patch-merge-key": "key", + "type": "string", + "description": "key is the label key that the selector applies to.", + "x-kubernetes-patch-strategy": "merge" + } + } + }, + "type": "array", + "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed." + } + } + }, + "namespaces": { + "items": { + "type": "string" + }, + "type": "array", + "description": "namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means \"this pod's namespace\"" + }, + "topologyKey": { + "type": "string", + "description": "This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed." + } + } + }, + "type": "array", + "description": "If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied." + }, + "preferredDuringSchedulingIgnoredDuringExecution": { + "items": { + "required": [ + "weight", + "podAffinityTerm" + ], + "description": "The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)", + "properties": { + "podAffinityTerm": { + "required": [ + "topologyKey" + ], + "description": "Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running", + "properties": { + "labelSelector": { + "description": "A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.", + "properties": { + "matchLabels": { + "additionalProperties": true, + "type": "object", + "description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + }, + "matchExpressions": { + "items": { + "required": [ + "key", + "operator" + ], + "description": "A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.", + "properties": { + "operator": { + "type": "string", + "description": "operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist." + }, + "values": { + "items": { + "type": "string" + }, + "type": "array", + "description": "values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch." + }, + "key": { + "x-kubernetes-patch-merge-key": "key", + "type": "string", + "description": "key is the label key that the selector applies to.", + "x-kubernetes-patch-strategy": "merge" + } + } + }, + "type": "array", + "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed." + } + } + }, + "namespaces": { + "items": { + "type": "string" + }, + "type": "array", + "description": "namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means \"this pod's namespace\"" + }, + "topologyKey": { + "type": "string", + "description": "This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed." + } + } + }, + "weight": { + "type": "integer", + "description": "weight associated with matching the corresponding podAffinityTerm, in the range 1-100.", + "format": "int32" + } + } + }, + "type": "array", + "description": "The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred." + } + } + } + } + }, + "tolerations": { + "items": { + "description": "The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator .", + "properties": { + "operator": { + "type": "string", + "description": "Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category." + }, + "value": { + "type": "string", + "description": "Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string." + }, + "tolerationSeconds": { + "type": "integer", + "description": "TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.", + "format": "int64" + }, + "effect": { + "type": "string", + "description": "Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute." + }, + "key": { + "type": "string", + "description": "Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys." + } + } + }, + "type": "array", + "description": "If specified, the pod's tolerations." + }, + "subdomain": { + "type": "string", + "description": "If specified, the fully qualified Pod hostname will be \"...svc.\". If not specified, the pod will not have a domainname at all." + }, + "hostPID": { + "type": "boolean", + "description": "Use the host's pid namespace. Optional: Default to false." + }, + "serviceAccountName": { + "type": "string", + "description": "ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/" + }, + "schedulerName": { + "type": "string", + "description": "If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler." + }, + "hostIPC": { + "type": "boolean", + "description": "Use the host's ipc namespace. Optional: Default to false." + }, + "dnsConfig": { + "description": "PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy.", + "properties": { + "nameservers": { + "items": { + "type": "string" + }, + "type": "array", + "description": "A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed." + }, + "searches": { + "items": { + "type": "string" + }, + "type": "array", + "description": "A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed." + }, + "options": { + "items": { + "description": "PodDNSConfigOption defines DNS resolver options of a pod.", + "properties": { + "name": { + "type": "string", + "description": "Required." + }, + "value": { + "type": "string" + } + } + }, + "type": "array", + "description": "A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy." + } + } + }, + "activeDeadlineSeconds": { + "type": "integer", + "description": "Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer.", + "format": "int64" + }, + "terminationGracePeriodSeconds": { + "type": "integer", + "description": "Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds.", + "format": "int64" + }, + "containers": { + "items": { + "required": [ + "name" + ], + "description": "A single application container that you want to run within a pod.", + "properties": { + "livenessProbe": { + "description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.", + "properties": { + "httpGet": { + "required": [ + "port" + ], + "description": "HTTPGetAction describes an action based on HTTP Get requests.", + "properties": { + "path": { + "type": "string", + "description": "Path to access on the HTTP server." + }, + "host": { + "type": "string", + "description": "Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead." + }, + "scheme": { + "type": "string", + "description": "Scheme to use for connecting to the host. Defaults to HTTP." + }, + "httpHeaders": { + "items": { + "required": [ + "name", + "value" + ], + "description": "HTTPHeader describes a custom header to be used in HTTP probes", + "properties": { + "name": { + "type": "string", + "description": "The header field name" + }, + "value": { + "type": "string", + "description": "The header field value" + } + } + }, + "type": "array", + "description": "Custom headers to set in the request. HTTP allows repeated headers." + }, + "port": { + "type": "string", + "format": "int-or-string" + } + } + }, + "timeoutSeconds": { + "type": "integer", + "description": "Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes", + "format": "int32" + }, + "exec": { + "description": "ExecAction describes a \"run in container\" action.", + "properties": { + "command": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy." + } + } + }, + "initialDelaySeconds": { + "type": "integer", + "description": "Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes", + "format": "int32" + }, + "tcpSocket": { + "required": [ + "port" + ], + "description": "TCPSocketAction describes an action based on opening a socket", + "properties": { + "host": { + "type": "string", + "description": "Optional: Host name to connect to, defaults to the pod IP." + }, + "port": { + "type": "string", + "format": "int-or-string" + } + } + }, + "periodSeconds": { + "type": "integer", + "description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.", + "format": "int32" + }, + "successThreshold": { + "type": "integer", + "description": "Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1.", + "format": "int32" + }, + "failureThreshold": { + "type": "integer", + "description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.", + "format": "int32" + } + } + }, + "stdin": { + "type": "boolean", + "description": "Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false." + }, + "securityContext": { + "description": "SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.", + "properties": { + "readOnlyRootFilesystem": { + "type": "boolean", + "description": "Whether this container has a read-only root filesystem. Default is false." + }, + "runAsUser": { + "type": "integer", + "description": "The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.", + "format": "int64" + }, + "allowPrivilegeEscalation": { + "type": "boolean", + "description": "AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN" + }, + "capabilities": { + "description": "Adds and removes POSIX capabilities from running containers.", + "properties": { + "add": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Added capabilities" + }, + "drop": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Removed capabilities" + } + } + }, + "runAsNonRoot": { + "type": "boolean", + "description": "Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence." + }, + "seLinuxOptions": { + "description": "SELinuxOptions are the labels to be applied to the container", + "properties": { + "type": { + "type": "string", + "description": "Type is a SELinux type label that applies to the container." + }, + "role": { + "type": "string", + "description": "Role is a SELinux role label that applies to the container." + }, + "user": { + "type": "string", + "description": "User is a SELinux user label that applies to the container." + }, + "level": { + "type": "string", + "description": "Level is SELinux level label that applies to the container." + } + } + }, + "privileged": { + "type": "boolean", + "description": "Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false." + } + } + }, + "name": { + "type": "string", + "description": "Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated." + }, + "envFrom": { + "items": { + "description": "EnvFromSource represents the source of a set of ConfigMaps", + "properties": { + "prefix": { + "type": "string", + "description": "An optional identifer to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER." + }, + "configMapRef": { + "description": "ConfigMapEnvSource selects a ConfigMap to populate the environment variables with.\n\nThe contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables.", + "properties": { + "optional": { + "type": "boolean", + "description": "Specify whether the ConfigMap must be defined" + }, + "name": { + "type": "string", + "description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names" + } + } + }, + "secretRef": { + "description": "SecretEnvSource selects a Secret to populate the environment variables with.\n\nThe contents of the target Secret's Data field will represent the key-value pairs as environment variables.", + "properties": { + "optional": { + "type": "boolean", + "description": "Specify whether the Secret must be defined" + }, + "name": { + "type": "string", + "description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names" + } + } + } + } + }, + "type": "array", + "description": "List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated." + }, + "volumeMounts": { + "items": { + "required": [ + "name", + "mountPath" + ], + "description": "VolumeMount describes a mounting of a Volume within a container.", + "properties": { + "subPath": { + "type": "string", + "description": "Path within the volume from which the container's volume should be mounted. Defaults to \"\" (volume's root)." + }, + "readOnly": { + "type": "boolean", + "description": "Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false." + }, + "mountPath": { + "type": "string", + "description": "Path within the container at which the volume should be mounted. Must not contain ':'." + }, + "mountPropagation": { + "type": "string", + "description": "mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationHostToContainer is used. This field is alpha in 1.8 and can be reworked or removed in a future release." + }, + "name": { + "type": "string", + "description": "This must match the Name of a Volume." + } + } + }, + "type": "array", + "description": "Pod volumes to mount into the container's filesystem. Cannot be updated.", + "x-kubernetes-patch-strategy": "merge", + "x-kubernetes-patch-merge-key": "mountPath" + }, + "image": { + "type": "string", + "description": "Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets." + }, + "args": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell" + }, + "stdinOnce": { + "type": "boolean", + "description": "Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false" + }, + "terminationMessagePolicy": { + "type": "string", + "description": "Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated." + }, + "ports": { + "items": { + "required": [ + "containerPort" + ], + "description": "ContainerPort represents a network port in a single container.", + "properties": { + "hostPort": { + "type": "integer", + "description": "Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.", + "format": "int32" + }, + "protocol": { + "type": "string", + "description": "Protocol for port. Must be UDP or TCP. Defaults to \"TCP\"." + }, + "containerPort": { + "type": "integer", + "description": "Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.", + "format": "int32" + }, + "name": { + "type": "string", + "description": "If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services." + }, + "hostIP": { + "type": "string", + "description": "What host IP to bind the external port to." + } + } + }, + "type": "array", + "description": "List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default \"0.0.0.0\" address inside a container will be accessible from the network. Cannot be updated.", + "x-kubernetes-patch-strategy": "merge", + "x-kubernetes-patch-merge-key": "containerPort" + }, + "volumeDevices": { + "items": { + "required": [ + "name", + "devicePath" + ], + "description": "volumeDevice describes a mapping of a raw block device within a container.", + "properties": { + "devicePath": { + "type": "string", + "description": "devicePath is the path inside of the container that the device will be mapped to." + }, + "name": { + "type": "string", + "description": "name must match the name of a persistentVolumeClaim in the pod" + } + } + }, + "type": "array", + "description": "volumeDevices is the list of block devices to be used by the container. This is an alpha feature and may change in the future.", + "x-kubernetes-patch-strategy": "merge", + "x-kubernetes-patch-merge-key": "devicePath" + }, + "tty": { + "type": "boolean", + "description": "Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false." + }, + "command": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell" + }, + "env": { + "items": { + "required": [ + "name" + ], + "description": "EnvVar represents an environment variable present in a Container.", + "properties": { + "valueFrom": { + "description": "EnvVarSource represents a source for the value of an EnvVar.", + "properties": { + "secretKeyRef": { + "required": [ + "key" + ], + "description": "SecretKeySelector selects a key of a Secret.", + "properties": { + "optional": { + "type": "boolean", + "description": "Specify whether the Secret or it's key must be defined" + }, + "name": { + "type": "string", + "description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names" + }, + "key": { + "type": "string", + "description": "The key of the secret to select from. Must be a valid secret key." + } + } + }, + "fieldRef": { + "required": [ + "fieldPath" + ], + "description": "ObjectFieldSelector selects an APIVersioned field of an object.", + "properties": { + "fieldPath": { + "type": "string", + "description": "Path of the field to select in the specified API version." + }, + "apiVersion": { + "type": "string", + "description": "Version of the schema the FieldPath is written in terms of, defaults to \"v1\"." + } + } + }, + "resourceFieldRef": { + "required": [ + "resource" + ], + "description": "ResourceFieldSelector represents container resources (cpu, memory) and their output format", + "properties": { + "containerName": { + "type": "string", + "description": "Container name: required for volumes, optional for env vars" + }, + "resource": { + "type": "string", + "description": "Required: resource to select" + }, + "divisor": { + "type": "string" + } + } + }, + "configMapKeyRef": { + "required": [ + "key" + ], + "description": "Selects a key from a ConfigMap.", + "properties": { + "optional": { + "type": "boolean", + "description": "Specify whether the ConfigMap or it's key must be defined" + }, + "name": { + "type": "string", + "description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names" + }, + "key": { + "type": "string", + "description": "The key to select." + } + } + } + } + }, + "name": { + "type": "string", + "description": "Name of the environment variable. Must be a C_IDENTIFIER." + }, + "value": { + "type": "string", + "description": "Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to \"\"." + } + } + }, + "type": "array", + "description": "List of environment variables to set in the container. Cannot be updated.", + "x-kubernetes-patch-strategy": "merge", + "x-kubernetes-patch-merge-key": "name" + }, + "imagePullPolicy": { + "type": "string", + "description": "Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images" + }, + "readinessProbe": { + "description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.", + "properties": { + "httpGet": { + "required": [ + "port" + ], + "description": "HTTPGetAction describes an action based on HTTP Get requests.", + "properties": { + "path": { + "type": "string", + "description": "Path to access on the HTTP server." + }, + "host": { + "type": "string", + "description": "Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead." + }, + "scheme": { + "type": "string", + "description": "Scheme to use for connecting to the host. Defaults to HTTP." + }, + "httpHeaders": { + "items": { + "required": [ + "name", + "value" + ], + "description": "HTTPHeader describes a custom header to be used in HTTP probes", + "properties": { + "name": { + "type": "string", + "description": "The header field name" + }, + "value": { + "type": "string", + "description": "The header field value" + } + } + }, + "type": "array", + "description": "Custom headers to set in the request. HTTP allows repeated headers." + }, + "port": { + "type": "string", + "format": "int-or-string" + } + } + }, + "timeoutSeconds": { + "type": "integer", + "description": "Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes", + "format": "int32" + }, + "exec": { + "description": "ExecAction describes a \"run in container\" action.", + "properties": { + "command": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy." + } + } + }, + "initialDelaySeconds": { + "type": "integer", + "description": "Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes", + "format": "int32" + }, + "tcpSocket": { + "required": [ + "port" + ], + "description": "TCPSocketAction describes an action based on opening a socket", + "properties": { + "host": { + "type": "string", + "description": "Optional: Host name to connect to, defaults to the pod IP." + }, + "port": { + "type": "string", + "format": "int-or-string" + } + } + }, + "periodSeconds": { + "type": "integer", + "description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.", + "format": "int32" + }, + "successThreshold": { + "type": "integer", + "description": "Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1.", + "format": "int32" + }, + "failureThreshold": { + "type": "integer", + "description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.", + "format": "int32" + } + } + }, + "terminationMessagePath": { + "type": "string", + "description": "Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated." + }, + "lifecycle": { + "description": "Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.", + "properties": { + "preStop": { + "description": "Handler defines a specific action that should be taken", + "properties": { + "httpGet": { + "required": [ + "port" + ], + "description": "HTTPGetAction describes an action based on HTTP Get requests.", + "properties": { + "path": { + "type": "string", + "description": "Path to access on the HTTP server." + }, + "host": { + "type": "string", + "description": "Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead." + }, + "scheme": { + "type": "string", + "description": "Scheme to use for connecting to the host. Defaults to HTTP." + }, + "httpHeaders": { + "items": { + "required": [ + "name", + "value" + ], + "description": "HTTPHeader describes a custom header to be used in HTTP probes", + "properties": { + "name": { + "type": "string", + "description": "The header field name" + }, + "value": { + "type": "string", + "description": "The header field value" + } + } + }, + "type": "array", + "description": "Custom headers to set in the request. HTTP allows repeated headers." + }, + "port": { + "type": "string", + "format": "int-or-string" + } + } + }, + "tcpSocket": { + "required": [ + "port" + ], + "description": "TCPSocketAction describes an action based on opening a socket", + "properties": { + "host": { + "type": "string", + "description": "Optional: Host name to connect to, defaults to the pod IP." + }, + "port": { + "type": "string", + "format": "int-or-string" + } + } + }, + "exec": { + "description": "ExecAction describes a \"run in container\" action.", + "properties": { + "command": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy." + } + } + } + } + }, + "postStart": { + "description": "Handler defines a specific action that should be taken", + "properties": { + "httpGet": { + "required": [ + "port" + ], + "description": "HTTPGetAction describes an action based on HTTP Get requests.", + "properties": { + "path": { + "type": "string", + "description": "Path to access on the HTTP server." + }, + "host": { + "type": "string", + "description": "Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead." + }, + "scheme": { + "type": "string", + "description": "Scheme to use for connecting to the host. Defaults to HTTP." + }, + "httpHeaders": { + "items": { + "required": [ + "name", + "value" + ], + "description": "HTTPHeader describes a custom header to be used in HTTP probes", + "properties": { + "name": { + "type": "string", + "description": "The header field name" + }, + "value": { + "type": "string", + "description": "The header field value" + } + } + }, + "type": "array", + "description": "Custom headers to set in the request. HTTP allows repeated headers." + }, + "port": { + "type": "string", + "format": "int-or-string" + } + } + }, + "tcpSocket": { + "required": [ + "port" + ], + "description": "TCPSocketAction describes an action based on opening a socket", + "properties": { + "host": { + "type": "string", + "description": "Optional: Host name to connect to, defaults to the pod IP." + }, + "port": { + "type": "string", + "format": "int-or-string" + } + } + }, + "exec": { + "description": "ExecAction describes a \"run in container\" action.", + "properties": { + "command": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy." + } + } + } + } + } + } + }, + "resources": { + "description": "ResourceRequirements describes the compute resource requirements.", + "properties": { + "requests": { + "additionalProperties": true, + "type": "object", + "description": "Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/" + }, + "limits": { + "additionalProperties": true, + "type": "object", + "description": "Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/" + } + } + }, + "workingDir": { + "type": "string", + "description": "Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated." + } + } + }, + "type": "array", + "description": "List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated.", + "x-kubernetes-patch-strategy": "merge", + "x-kubernetes-patch-merge-key": "name" + }, + "volumes": { + "items": { + "required": [ + "name" + ], + "description": "Volume represents a named volume in a pod that may be accessed by any container in the pod.", + "properties": { + "portworxVolume": { + "required": [ + "volumeID" + ], + "description": "PortworxVolumeSource represents a Portworx volume resource.", + "properties": { + "readOnly": { + "type": "boolean", + "description": "Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts." + }, + "volumeID": { + "type": "string", + "description": "VolumeID uniquely identifies a Portworx volume" + }, + "fsType": { + "type": "string", + "description": "FSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\". Implicitly inferred to be \"ext4\" if unspecified." + } + } + }, + "glusterfs": { + "required": [ + "endpoints", + "path" + ], + "description": "Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.", + "properties": { + "path": { + "type": "string", + "description": "Path is the Glusterfs volume path. More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod" + }, + "readOnly": { + "type": "boolean", + "description": "ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod" + }, + "endpoints": { + "type": "string", + "description": "EndpointsName is the endpoint name that details Glusterfs topology. More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod" + } + } + }, + "gitRepo": { + "required": [ + "repository" + ], + "description": "Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling.", + "properties": { + "directory": { + "type": "string", + "description": "Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name." + }, + "repository": { + "type": "string", + "description": "Repository URL" + }, + "revision": { + "type": "string", + "description": "Commit hash for the specified revision." + } + } + }, + "flocker": { + "description": "Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling.", + "properties": { + "datasetName": { + "type": "string", + "description": "Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated" + }, + "datasetUUID": { + "type": "string", + "description": "UUID of the dataset. This is unique identifier of a Flocker dataset" + } + } + }, + "storageos": { + "description": "Represents a StorageOS persistent volume resource.", + "properties": { + "volumeName": { + "type": "string", + "description": "VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace." + }, + "readOnly": { + "type": "boolean", + "description": "Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts." + }, + "volumeNamespace": { + "type": "string", + "description": "VolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to \"default\" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created." + }, + "secretRef": { + "description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.", + "properties": { + "name": { + "type": "string", + "description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names" + } + } + }, + "fsType": { + "type": "string", + "description": "Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified." + } + } + }, + "iscsi": { + "required": [ + "targetPortal", + "iqn", + "lun" + ], + "description": "Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.", + "properties": { + "targetPortal": { + "type": "string", + "description": "iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260)." + }, + "portals": { + "items": { + "type": "string" + }, + "type": "array", + "description": "iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260)." + }, + "secretRef": { + "description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.", + "properties": { + "name": { + "type": "string", + "description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names" + } + } + }, + "fsType": { + "type": "string", + "description": "Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi" + }, + "readOnly": { + "type": "boolean", + "description": "ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false." + }, + "chapAuthSession": { + "type": "boolean", + "description": "whether support iSCSI Session CHAP authentication" + }, + "initiatorName": { + "type": "string", + "description": "Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection." + }, + "iscsiInterface": { + "type": "string", + "description": "iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp)." + }, + "chapAuthDiscovery": { + "type": "boolean", + "description": "whether support iSCSI Discovery CHAP authentication" + }, + "iqn": { + "type": "string", + "description": "Target iSCSI Qualified Name." + }, + "lun": { + "type": "integer", + "description": "iSCSI Target Lun number.", + "format": "int32" + } + } + }, + "projected": { + "required": [ + "sources" + ], + "description": "Represents a projected volume source", + "properties": { + "sources": { + "items": { + "description": "Projection that may be projected along with other supported volume types", + "properties": { + "configMap": { + "description": "Adapts a ConfigMap into a projected volume.\n\nThe contents of the target ConfigMap's Data field will be presented in a projected volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. Note that this is identical to a configmap volume source without the default mode.", + "properties": { + "items": { + "items": { + "required": [ + "key", + "path" + ], + "description": "Maps a string key to a path within a volume.", + "properties": { + "path": { + "type": "string", + "description": "The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'." + }, + "mode": { + "type": "integer", + "description": "Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.", + "format": "int32" + }, + "key": { + "type": "string", + "description": "The key to project." + } + } + }, + "type": "array", + "description": "If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'." + }, + "optional": { + "type": "boolean", + "description": "Specify whether the ConfigMap or it's keys must be defined" + }, + "name": { + "type": "string", + "description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names" + } + } + }, + "secret": { + "description": "Adapts a secret into a projected volume.\n\nThe contents of the target Secret's Data field will be presented in a projected volume as files using the keys in the Data field as the file names. Note that this is identical to a secret volume source without the default mode.", + "properties": { + "items": { + "items": { + "required": [ + "key", + "path" + ], + "description": "Maps a string key to a path within a volume.", + "properties": { + "path": { + "type": "string", + "description": "The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'." + }, + "mode": { + "type": "integer", + "description": "Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.", + "format": "int32" + }, + "key": { + "type": "string", + "description": "The key to project." + } + } + }, + "type": "array", + "description": "If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'." + }, + "optional": { + "type": "boolean", + "description": "Specify whether the Secret or its key must be defined" + }, + "name": { + "type": "string", + "description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names" + } + } + }, + "downwardAPI": { + "description": "Represents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode.", + "properties": { + "items": { + "items": { + "required": [ + "path" + ], + "description": "DownwardAPIVolumeFile represents information to create the file containing the pod field", + "properties": { + "path": { + "type": "string", + "description": "Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'" + }, + "fieldRef": { + "required": [ + "fieldPath" + ], + "description": "ObjectFieldSelector selects an APIVersioned field of an object.", + "properties": { + "fieldPath": { + "type": "string", + "description": "Path of the field to select in the specified API version." + }, + "apiVersion": { + "type": "string", + "description": "Version of the schema the FieldPath is written in terms of, defaults to \"v1\"." + } + } + }, + "mode": { + "type": "integer", + "description": "Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.", + "format": "int32" + }, + "resourceFieldRef": { + "required": [ + "resource" + ], + "description": "ResourceFieldSelector represents container resources (cpu, memory) and their output format", + "properties": { + "containerName": { + "type": "string", + "description": "Container name: required for volumes, optional for env vars" + }, + "resource": { + "type": "string", + "description": "Required: resource to select" + }, + "divisor": { + "type": "string" + } + } + } + } + }, + "type": "array", + "description": "Items is a list of DownwardAPIVolume file" + } + } + } + } + }, + "type": "array", + "description": "list of volume projections" + }, + "defaultMode": { + "type": "integer", + "description": "Mode bits to use on created files by default. Must be a value between 0 and 0777. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.", + "format": "int32" + } + } + }, + "secret": { + "description": "Adapts a Secret into a volume.\n\nThe contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling.", + "properties": { + "items": { + "items": { + "required": [ + "key", + "path" + ], + "description": "Maps a string key to a path within a volume.", + "properties": { + "path": { + "type": "string", + "description": "The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'." + }, + "mode": { + "type": "integer", + "description": "Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.", + "format": "int32" + }, + "key": { + "type": "string", + "description": "The key to project." + } + } + }, + "type": "array", + "description": "If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'." + }, + "optional": { + "type": "boolean", + "description": "Specify whether the Secret or it's keys must be defined" + }, + "defaultMode": { + "type": "integer", + "description": "Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.", + "format": "int32" + }, + "secretName": { + "type": "string", + "description": "Name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret" + } + } + }, + "flexVolume": { + "required": [ + "driver" + ], + "description": "FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. This is an alpha feature and may change in future.", + "properties": { + "secretRef": { + "description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.", + "properties": { + "name": { + "type": "string", + "description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names" + } + } + }, + "readOnly": { + "type": "boolean", + "description": "Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts." + }, + "driver": { + "type": "string", + "description": "Driver is the name of the driver to use for this volume." + }, + "options": { + "additionalProperties": true, + "type": "object", + "description": "Optional: Extra command options if any." + }, + "fsType": { + "type": "string", + "description": "Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". The default filesystem depends on FlexVolume script." + } + } + }, + "photonPersistentDisk": { + "required": [ + "pdID" + ], + "description": "Represents a Photon Controller persistent disk resource.", + "properties": { + "pdID": { + "type": "string", + "description": "ID that identifies Photon Controller persistent disk" + }, + "fsType": { + "type": "string", + "description": "Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified." + } + } + }, + "azureDisk": { + "required": [ + "diskName", + "diskURI" + ], + "description": "AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.", + "properties": { + "diskName": { + "type": "string", + "description": "The Name of the data disk in the blob storage" + }, + "cachingMode": { + "type": "string", + "description": "Host Caching mode: None, Read Only, Read Write." + }, + "kind": { + "type": "string", + "description": "Expected values Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared" + }, + "fsType": { + "type": "string", + "description": "Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified." + }, + "diskURI": { + "type": "string", + "description": "The URI the data disk in the blob storage" + }, + "readOnly": { + "type": "boolean", + "description": "Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts." + } + } + }, + "fc": { + "description": "Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling.", + "properties": { + "readOnly": { + "type": "boolean", + "description": "Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts." + }, + "wwids": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously." + }, + "targetWWNs": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Optional: FC target worldwide names (WWNs)" + }, + "lun": { + "type": "integer", + "description": "Optional: FC target lun number", + "format": "int32" + }, + "fsType": { + "type": "string", + "description": "Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified." + } + } + }, + "scaleIO": { + "required": [ + "gateway", + "system", + "secretRef" + ], + "description": "ScaleIOVolumeSource represents a persistent ScaleIO volume", + "properties": { + "storageMode": { + "type": "string", + "description": "Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned." + }, + "secretRef": { + "description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.", + "properties": { + "name": { + "type": "string", + "description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names" + } + } + }, + "protectionDomain": { + "type": "string", + "description": "The name of the ScaleIO Protection Domain for the configured storage." + }, + "volumeName": { + "type": "string", + "description": "The name of a volume already created in the ScaleIO system that is associated with this volume source." + }, + "sslEnabled": { + "type": "boolean", + "description": "Flag to enable/disable SSL communication with Gateway, default false" + }, + "system": { + "type": "string", + "description": "The name of the storage system as configured in ScaleIO." + }, + "fsType": { + "type": "string", + "description": "Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified." + }, + "readOnly": { + "type": "boolean", + "description": "Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts." + }, + "storagePool": { + "type": "string", + "description": "The ScaleIO Storage Pool associated with the protection domain." + }, + "gateway": { + "type": "string", + "description": "The host address of the ScaleIO API Gateway." + } + } + }, + "emptyDir": { + "description": "Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling.", + "properties": { + "sizeLimit": { + "type": "string" + }, + "medium": { + "type": "string", + "description": "What type of storage medium should back this directory. The default is \"\" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir" + } + } + }, + "persistentVolumeClaim": { + "required": [ + "claimName" + ], + "description": "PersistentVolumeClaimVolumeSource references the user's PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system).", + "properties": { + "readOnly": { + "type": "boolean", + "description": "Will force the ReadOnly setting in VolumeMounts. Default false." + }, + "claimName": { + "type": "string", + "description": "ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims" + } + } + }, + "configMap": { + "description": "Adapts a ConfigMap into a volume.\n\nThe contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling.", + "properties": { + "items": { + "items": { + "required": [ + "key", + "path" + ], + "description": "Maps a string key to a path within a volume.", + "properties": { + "path": { + "type": "string", + "description": "The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'." + }, + "mode": { + "type": "integer", + "description": "Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.", + "format": "int32" + }, + "key": { + "type": "string", + "description": "The key to project." + } + } + }, + "type": "array", + "description": "If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'." + }, + "optional": { + "type": "boolean", + "description": "Specify whether the ConfigMap or it's keys must be defined" + }, + "defaultMode": { + "type": "integer", + "description": "Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.", + "format": "int32" + }, + "name": { + "type": "string", + "description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names" + } + } + }, + "rbd": { + "required": [ + "monitors", + "image" + ], + "description": "Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.", + "properties": { + "secretRef": { + "description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.", + "properties": { + "name": { + "type": "string", + "description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names" + } + } + }, + "image": { + "type": "string", + "description": "The rados image name. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it" + }, + "keyring": { + "type": "string", + "description": "Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it" + }, + "fsType": { + "type": "string", + "description": "Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd" + }, + "readOnly": { + "type": "boolean", + "description": "ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it" + }, + "user": { + "type": "string", + "description": "The rados user name. Default is admin. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it" + }, + "monitors": { + "items": { + "type": "string" + }, + "type": "array", + "description": "A collection of Ceph monitors. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it" + }, + "pool": { + "type": "string", + "description": "The rados pool name. Default is rbd. More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it" + } + } + }, + "name": { + "type": "string", + "description": "Volume's name. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names" + }, + "azureFile": { + "required": [ + "secretName", + "shareName" + ], + "description": "AzureFile represents an Azure File Service mount on the host and bind mount to the pod.", + "properties": { + "shareName": { + "type": "string", + "description": "Share Name" + }, + "readOnly": { + "type": "boolean", + "description": "Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts." + }, + "secretName": { + "type": "string", + "description": "the name of secret that contains Azure Storage Account Name and Key" + } + } + }, + "quobyte": { + "required": [ + "registry", + "volume" + ], + "description": "Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.", + "properties": { + "volume": { + "type": "string", + "description": "Volume is a string that references an already created Quobyte volume by name." + }, + "readOnly": { + "type": "boolean", + "description": "ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false." + }, + "group": { + "type": "string", + "description": "Group to map volume access to Default is no group" + }, + "registry": { + "type": "string", + "description": "Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes" + }, + "user": { + "type": "string", + "description": "User to map volume access to Defaults to serivceaccount user" + } + } + }, + "hostPath": { + "required": [ + "path" + ], + "description": "Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.", + "properties": { + "path": { + "type": "string", + "description": "Path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath" + }, + "type": { + "type": "string", + "description": "Type for HostPath Volume Defaults to \"\" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath" + } + } + }, + "nfs": { + "required": [ + "server", + "path" + ], + "description": "Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling.", + "properties": { + "path": { + "type": "string", + "description": "Path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs" + }, + "readOnly": { + "type": "boolean", + "description": "ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs" + }, + "server": { + "type": "string", + "description": "Server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs" + } + } + }, + "vsphereVolume": { + "required": [ + "volumePath" + ], + "description": "Represents a vSphere volume resource.", + "properties": { + "storagePolicyName": { + "type": "string", + "description": "Storage Policy Based Management (SPBM) profile name." + }, + "volumePath": { + "type": "string", + "description": "Path that identifies vSphere volume vmdk" + }, + "storagePolicyID": { + "type": "string", + "description": "Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName." + }, + "fsType": { + "type": "string", + "description": "Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified." + } + } + }, + "cinder": { + "required": [ + "volumeID" + ], + "description": "Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling.", + "properties": { + "readOnly": { + "type": "boolean", + "description": "Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md" + }, + "volumeID": { + "type": "string", + "description": "volume id used to identify the volume in cinder More info: https://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md" + }, + "fsType": { + "type": "string", + "description": "Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md" + } + } + }, + "awsElasticBlockStore": { + "required": [ + "volumeID" + ], + "description": "Represents a Persistent Disk resource in AWS.\n\nAn AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling.", + "properties": { + "readOnly": { + "type": "boolean", + "description": "Specify \"true\" to force and set the ReadOnly property in VolumeMounts to \"true\". If omitted, the default is \"false\". More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore" + }, + "partition": { + "type": "integer", + "description": "The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as \"1\". Similarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty).", + "format": "int32" + }, + "volumeID": { + "type": "string", + "description": "Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore" + }, + "fsType": { + "type": "string", + "description": "Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore" + } + } + }, + "cephfs": { + "required": [ + "monitors" + ], + "description": "Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.", + "properties": { + "secretRef": { + "description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.", + "properties": { + "name": { + "type": "string", + "description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names" + } + } + }, + "secretFile": { + "type": "string", + "description": "Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it" + }, + "readOnly": { + "type": "boolean", + "description": "Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it" + }, + "user": { + "type": "string", + "description": "Optional: User is the rados user name, default is admin More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it" + }, + "path": { + "type": "string", + "description": "Optional: Used as the mounted root, rather than the full Ceph tree, default is /" + }, + "monitors": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Required: Monitors is a collection of Ceph monitors More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it" + } + } + }, + "downwardAPI": { + "description": "DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling.", + "properties": { + "items": { + "items": { + "required": [ + "path" + ], + "description": "DownwardAPIVolumeFile represents information to create the file containing the pod field", + "properties": { + "path": { + "type": "string", + "description": "Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'" + }, + "fieldRef": { + "required": [ + "fieldPath" + ], + "description": "ObjectFieldSelector selects an APIVersioned field of an object.", + "properties": { + "fieldPath": { + "type": "string", + "description": "Path of the field to select in the specified API version." + }, + "apiVersion": { + "type": "string", + "description": "Version of the schema the FieldPath is written in terms of, defaults to \"v1\"." + } + } + }, + "mode": { + "type": "integer", + "description": "Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.", + "format": "int32" + }, + "resourceFieldRef": { + "required": [ + "resource" + ], + "description": "ResourceFieldSelector represents container resources (cpu, memory) and their output format", + "properties": { + "containerName": { + "type": "string", + "description": "Container name: required for volumes, optional for env vars" + }, + "resource": { + "type": "string", + "description": "Required: resource to select" + }, + "divisor": { + "type": "string" + } + } + } + } + }, + "type": "array", + "description": "Items is a list of downward API volume file" + }, + "defaultMode": { + "type": "integer", + "description": "Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.", + "format": "int32" + } + } + }, + "gcePersistentDisk": { + "required": [ + "pdName" + ], + "description": "Represents a Persistent Disk resource in Google Compute Engine.\n\nA GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling.", + "properties": { + "readOnly": { + "type": "boolean", + "description": "ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk" + }, + "partition": { + "type": "integer", + "description": "The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as \"1\". Similarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk", + "format": "int32" + }, + "pdName": { + "type": "string", + "description": "Unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk" + }, + "fsType": { + "type": "string", + "description": "Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk" + } + } + } + } + }, + "type": "array", + "description": "List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes", + "x-kubernetes-patch-strategy": "merge,retainKeys", + "x-kubernetes-patch-merge-key": "name" + }, + "initContainers": { + "items": { + "required": [ + "name" + ], + "description": "A single application container that you want to run within a pod.", + "properties": { + "livenessProbe": { + "description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.", + "properties": { + "httpGet": { + "required": [ + "port" + ], + "description": "HTTPGetAction describes an action based on HTTP Get requests.", + "properties": { + "path": { + "type": "string", + "description": "Path to access on the HTTP server." + }, + "host": { + "type": "string", + "description": "Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead." + }, + "scheme": { + "type": "string", + "description": "Scheme to use for connecting to the host. Defaults to HTTP." + }, + "httpHeaders": { + "items": { + "required": [ + "name", + "value" + ], + "description": "HTTPHeader describes a custom header to be used in HTTP probes", + "properties": { + "name": { + "type": "string", + "description": "The header field name" + }, + "value": { + "type": "string", + "description": "The header field value" + } + } + }, + "type": "array", + "description": "Custom headers to set in the request. HTTP allows repeated headers." + }, + "port": { + "type": "string", + "format": "int-or-string" + } + } + }, + "timeoutSeconds": { + "type": "integer", + "description": "Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes", + "format": "int32" + }, + "exec": { + "description": "ExecAction describes a \"run in container\" action.", + "properties": { + "command": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy." + } + } + }, + "initialDelaySeconds": { + "type": "integer", + "description": "Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes", + "format": "int32" + }, + "tcpSocket": { + "required": [ + "port" + ], + "description": "TCPSocketAction describes an action based on opening a socket", + "properties": { + "host": { + "type": "string", + "description": "Optional: Host name to connect to, defaults to the pod IP." + }, + "port": { + "type": "string", + "format": "int-or-string" + } + } + }, + "periodSeconds": { + "type": "integer", + "description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.", + "format": "int32" + }, + "successThreshold": { + "type": "integer", + "description": "Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1.", + "format": "int32" + }, + "failureThreshold": { + "type": "integer", + "description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.", + "format": "int32" + } + } + }, + "stdin": { + "type": "boolean", + "description": "Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false." + }, + "securityContext": { + "description": "SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.", + "properties": { + "readOnlyRootFilesystem": { + "type": "boolean", + "description": "Whether this container has a read-only root filesystem. Default is false." + }, + "runAsUser": { + "type": "integer", + "description": "The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.", + "format": "int64" + }, + "allowPrivilegeEscalation": { + "type": "boolean", + "description": "AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN" + }, + "capabilities": { + "description": "Adds and removes POSIX capabilities from running containers.", + "properties": { + "add": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Added capabilities" + }, + "drop": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Removed capabilities" + } + } + }, + "runAsNonRoot": { + "type": "boolean", + "description": "Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence." + }, + "seLinuxOptions": { + "description": "SELinuxOptions are the labels to be applied to the container", + "properties": { + "type": { + "type": "string", + "description": "Type is a SELinux type label that applies to the container." + }, + "role": { + "type": "string", + "description": "Role is a SELinux role label that applies to the container." + }, + "user": { + "type": "string", + "description": "User is a SELinux user label that applies to the container." + }, + "level": { + "type": "string", + "description": "Level is SELinux level label that applies to the container." + } + } + }, + "privileged": { + "type": "boolean", + "description": "Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false." + } + } + }, + "name": { + "type": "string", + "description": "Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated." + }, + "envFrom": { + "items": { + "description": "EnvFromSource represents the source of a set of ConfigMaps", + "properties": { + "prefix": { + "type": "string", + "description": "An optional identifer to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER." + }, + "configMapRef": { + "description": "ConfigMapEnvSource selects a ConfigMap to populate the environment variables with.\n\nThe contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables.", + "properties": { + "optional": { + "type": "boolean", + "description": "Specify whether the ConfigMap must be defined" + }, + "name": { + "type": "string", + "description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names" + } + } + }, + "secretRef": { + "description": "SecretEnvSource selects a Secret to populate the environment variables with.\n\nThe contents of the target Secret's Data field will represent the key-value pairs as environment variables.", + "properties": { + "optional": { + "type": "boolean", + "description": "Specify whether the Secret must be defined" + }, + "name": { + "type": "string", + "description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names" + } + } + } + } + }, + "type": "array", + "description": "List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated." + }, + "volumeMounts": { + "items": { + "required": [ + "name", + "mountPath" + ], + "description": "VolumeMount describes a mounting of a Volume within a container.", + "properties": { + "subPath": { + "type": "string", + "description": "Path within the volume from which the container's volume should be mounted. Defaults to \"\" (volume's root)." + }, + "readOnly": { + "type": "boolean", + "description": "Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false." + }, + "mountPath": { + "type": "string", + "description": "Path within the container at which the volume should be mounted. Must not contain ':'." + }, + "mountPropagation": { + "type": "string", + "description": "mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationHostToContainer is used. This field is alpha in 1.8 and can be reworked or removed in a future release." + }, + "name": { + "type": "string", + "description": "This must match the Name of a Volume." + } + } + }, + "type": "array", + "description": "Pod volumes to mount into the container's filesystem. Cannot be updated.", + "x-kubernetes-patch-strategy": "merge", + "x-kubernetes-patch-merge-key": "mountPath" + }, + "image": { + "type": "string", + "description": "Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets." + }, + "args": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell" + }, + "stdinOnce": { + "type": "boolean", + "description": "Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false" + }, + "terminationMessagePolicy": { + "type": "string", + "description": "Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated." + }, + "ports": { + "items": { + "required": [ + "containerPort" + ], + "description": "ContainerPort represents a network port in a single container.", + "properties": { + "hostPort": { + "type": "integer", + "description": "Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.", + "format": "int32" + }, + "protocol": { + "type": "string", + "description": "Protocol for port. Must be UDP or TCP. Defaults to \"TCP\"." + }, + "containerPort": { + "type": "integer", + "description": "Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.", + "format": "int32" + }, + "name": { + "type": "string", + "description": "If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services." + }, + "hostIP": { + "type": "string", + "description": "What host IP to bind the external port to." + } + } + }, + "type": "array", + "description": "List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default \"0.0.0.0\" address inside a container will be accessible from the network. Cannot be updated.", + "x-kubernetes-patch-strategy": "merge", + "x-kubernetes-patch-merge-key": "containerPort" + }, + "volumeDevices": { + "items": { + "required": [ + "name", + "devicePath" + ], + "description": "volumeDevice describes a mapping of a raw block device within a container.", + "properties": { + "devicePath": { + "type": "string", + "description": "devicePath is the path inside of the container that the device will be mapped to." + }, + "name": { + "type": "string", + "description": "name must match the name of a persistentVolumeClaim in the pod" + } + } + }, + "type": "array", + "description": "volumeDevices is the list of block devices to be used by the container. This is an alpha feature and may change in the future.", + "x-kubernetes-patch-strategy": "merge", + "x-kubernetes-patch-merge-key": "devicePath" + }, + "tty": { + "type": "boolean", + "description": "Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false." + }, + "command": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell" + }, + "env": { + "items": { + "required": [ + "name" + ], + "description": "EnvVar represents an environment variable present in a Container.", + "properties": { + "valueFrom": { + "description": "EnvVarSource represents a source for the value of an EnvVar.", + "properties": { + "secretKeyRef": { + "required": [ + "key" + ], + "description": "SecretKeySelector selects a key of a Secret.", + "properties": { + "optional": { + "type": "boolean", + "description": "Specify whether the Secret or it's key must be defined" + }, + "name": { + "type": "string", + "description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names" + }, + "key": { + "type": "string", + "description": "The key of the secret to select from. Must be a valid secret key." + } + } + }, + "fieldRef": { + "required": [ + "fieldPath" + ], + "description": "ObjectFieldSelector selects an APIVersioned field of an object.", + "properties": { + "fieldPath": { + "type": "string", + "description": "Path of the field to select in the specified API version." + }, + "apiVersion": { + "type": "string", + "description": "Version of the schema the FieldPath is written in terms of, defaults to \"v1\"." + } + } + }, + "resourceFieldRef": { + "required": [ + "resource" + ], + "description": "ResourceFieldSelector represents container resources (cpu, memory) and their output format", + "properties": { + "containerName": { + "type": "string", + "description": "Container name: required for volumes, optional for env vars" + }, + "resource": { + "type": "string", + "description": "Required: resource to select" + }, + "divisor": { + "type": "string" + } + } + }, + "configMapKeyRef": { + "required": [ + "key" + ], + "description": "Selects a key from a ConfigMap.", + "properties": { + "optional": { + "type": "boolean", + "description": "Specify whether the ConfigMap or it's key must be defined" + }, + "name": { + "type": "string", + "description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names" + }, + "key": { + "type": "string", + "description": "The key to select." + } + } + } + } + }, + "name": { + "type": "string", + "description": "Name of the environment variable. Must be a C_IDENTIFIER." + }, + "value": { + "type": "string", + "description": "Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to \"\"." + } + } + }, + "type": "array", + "description": "List of environment variables to set in the container. Cannot be updated.", + "x-kubernetes-patch-strategy": "merge", + "x-kubernetes-patch-merge-key": "name" + }, + "imagePullPolicy": { + "type": "string", + "description": "Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images" + }, + "readinessProbe": { + "description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.", + "properties": { + "httpGet": { + "required": [ + "port" + ], + "description": "HTTPGetAction describes an action based on HTTP Get requests.", + "properties": { + "path": { + "type": "string", + "description": "Path to access on the HTTP server." + }, + "host": { + "type": "string", + "description": "Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead." + }, + "scheme": { + "type": "string", + "description": "Scheme to use for connecting to the host. Defaults to HTTP." + }, + "httpHeaders": { + "items": { + "required": [ + "name", + "value" + ], + "description": "HTTPHeader describes a custom header to be used in HTTP probes", + "properties": { + "name": { + "type": "string", + "description": "The header field name" + }, + "value": { + "type": "string", + "description": "The header field value" + } + } + }, + "type": "array", + "description": "Custom headers to set in the request. HTTP allows repeated headers." + }, + "port": { + "type": "string", + "format": "int-or-string" + } + } + }, + "timeoutSeconds": { + "type": "integer", + "description": "Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes", + "format": "int32" + }, + "exec": { + "description": "ExecAction describes a \"run in container\" action.", + "properties": { + "command": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy." + } + } + }, + "initialDelaySeconds": { + "type": "integer", + "description": "Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes", + "format": "int32" + }, + "tcpSocket": { + "required": [ + "port" + ], + "description": "TCPSocketAction describes an action based on opening a socket", + "properties": { + "host": { + "type": "string", + "description": "Optional: Host name to connect to, defaults to the pod IP." + }, + "port": { + "type": "string", + "format": "int-or-string" + } + } + }, + "periodSeconds": { + "type": "integer", + "description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.", + "format": "int32" + }, + "successThreshold": { + "type": "integer", + "description": "Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1.", + "format": "int32" + }, + "failureThreshold": { + "type": "integer", + "description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.", + "format": "int32" + } + } + }, + "terminationMessagePath": { + "type": "string", + "description": "Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated." + }, + "lifecycle": { + "description": "Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.", + "properties": { + "preStop": { + "description": "Handler defines a specific action that should be taken", + "properties": { + "httpGet": { + "required": [ + "port" + ], + "description": "HTTPGetAction describes an action based on HTTP Get requests.", + "properties": { + "path": { + "type": "string", + "description": "Path to access on the HTTP server." + }, + "host": { + "type": "string", + "description": "Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead." + }, + "scheme": { + "type": "string", + "description": "Scheme to use for connecting to the host. Defaults to HTTP." + }, + "httpHeaders": { + "items": { + "required": [ + "name", + "value" + ], + "description": "HTTPHeader describes a custom header to be used in HTTP probes", + "properties": { + "name": { + "type": "string", + "description": "The header field name" + }, + "value": { + "type": "string", + "description": "The header field value" + } + } + }, + "type": "array", + "description": "Custom headers to set in the request. HTTP allows repeated headers." + }, + "port": { + "type": "string", + "format": "int-or-string" + } + } + }, + "tcpSocket": { + "required": [ + "port" + ], + "description": "TCPSocketAction describes an action based on opening a socket", + "properties": { + "host": { + "type": "string", + "description": "Optional: Host name to connect to, defaults to the pod IP." + }, + "port": { + "type": "string", + "format": "int-or-string" + } + } + }, + "exec": { + "description": "ExecAction describes a \"run in container\" action.", + "properties": { + "command": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy." + } + } + } + } + }, + "postStart": { + "description": "Handler defines a specific action that should be taken", + "properties": { + "httpGet": { + "required": [ + "port" + ], + "description": "HTTPGetAction describes an action based on HTTP Get requests.", + "properties": { + "path": { + "type": "string", + "description": "Path to access on the HTTP server." + }, + "host": { + "type": "string", + "description": "Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead." + }, + "scheme": { + "type": "string", + "description": "Scheme to use for connecting to the host. Defaults to HTTP." + }, + "httpHeaders": { + "items": { + "required": [ + "name", + "value" + ], + "description": "HTTPHeader describes a custom header to be used in HTTP probes", + "properties": { + "name": { + "type": "string", + "description": "The header field name" + }, + "value": { + "type": "string", + "description": "The header field value" + } + } + }, + "type": "array", + "description": "Custom headers to set in the request. HTTP allows repeated headers." + }, + "port": { + "type": "string", + "format": "int-or-string" + } + } + }, + "tcpSocket": { + "required": [ + "port" + ], + "description": "TCPSocketAction describes an action based on opening a socket", + "properties": { + "host": { + "type": "string", + "description": "Optional: Host name to connect to, defaults to the pod IP." + }, + "port": { + "type": "string", + "format": "int-or-string" + } + } + }, + "exec": { + "description": "ExecAction describes a \"run in container\" action.", + "properties": { + "command": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy." + } + } + } + } + } + } + }, + "resources": { + "description": "ResourceRequirements describes the compute resource requirements.", + "properties": { + "requests": { + "additionalProperties": true, + "type": "object", + "description": "Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/" + }, + "limits": { + "additionalProperties": true, + "type": "object", + "description": "Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/" + } + } + }, + "workingDir": { + "type": "string", + "description": "Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated." + } + } + }, + "type": "array", + "description": "List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, or Liveness probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/", + "x-kubernetes-patch-strategy": "merge", + "x-kubernetes-patch-merge-key": "name" + }, + "imagePullSecrets": { + "items": { + "description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.", + "properties": { + "name": { + "type": "string", + "description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names" + } + } + }, + "type": "array", + "description": "ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod", + "x-kubernetes-patch-strategy": "merge", + "x-kubernetes-patch-merge-key": "name" + } + } + }, + "metadata": { + "description": "ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.", + "properties": { + "ownerReferences": { + "items": { + "required": [ + "apiVersion", + "kind", + "name", + "uid" + ], + "description": "OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.", + "properties": { + "kind": { + "type": "string", + "description": "Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds" + }, + "uid": { + "type": "string", + "description": "UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids" + }, + "apiVersion": { + "type": "string", + "description": "API version of the referent." + }, + "controller": { + "type": "boolean", + "description": "If true, this reference points to the managing controller." + }, + "blockOwnerDeletion": { + "type": "boolean", + "description": "If true, AND if the owner has the \"foregroundDeletion\" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs \"delete\" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned." + }, + "name": { + "type": "string", + "description": "Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names" + } + } + }, + "type": "array", + "description": "List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.", + "x-kubernetes-patch-strategy": "merge", + "x-kubernetes-patch-merge-key": "uid" + }, + "name": { + "type": "string", + "description": "Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names" + }, + "deletionTimestamp": { + "type": "string", + "format": "date-time" + }, + "clusterName": { + "type": "string", + "description": "The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request." + }, + "deletionGracePeriodSeconds": { + "type": "integer", + "description": "Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.", + "format": "int64" + }, + "labels": { + "additionalProperties": true, + "type": "object", + "description": "Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels" + }, + "namespace": { + "type": "string", + "description": "Namespace defines the space within each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces" + }, + "generation": { + "type": "integer", + "description": "A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.", + "format": "int64" + }, + "finalizers": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.", + "x-kubernetes-patch-strategy": "merge" + }, + "initializers": { + "required": [ + "pending" + ], + "description": "Initializers tracks the progress of initialization.", + "properties": { + "result": { + "x-kubernetes-group-version-kind": [ + { + "kind": "Status", + "version": "v1", + "group": "" + } + ], + "description": "Status is a return value for calls that don't return other objects.", + "properties": { + "status": { + "type": "string", + "description": "Status of the operation. One of: \"Success\" or \"Failure\". More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status" + }, + "kind": { + "type": "string", + "description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds" + }, + "code": { + "type": "integer", + "description": "Suggested HTTP return code for this status, 0 if not set.", + "format": "int32" + }, + "apiVersion": { + "type": "string", + "description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources" + }, + "reason": { + "type": "string", + "description": "A machine-readable description of why this operation is in the \"Failure\" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it." + }, + "details": { + "description": "StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.", + "properties": { + "kind": { + "type": "string", + "description": "The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds" + }, + "group": { + "type": "string", + "description": "The group attribute of the resource associated with the status StatusReason." + }, + "name": { + "type": "string", + "description": "The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described)." + }, + "retryAfterSeconds": { + "type": "integer", + "description": "If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action.", + "format": "int32" + }, + "causes": { + "items": { + "description": "StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.", + "properties": { + "field": { + "type": "string", + "description": "The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional.\n\nExamples:\n \"name\" - the field \"name\" on the current resource\n \"items[0].name\" - the field \"name\" on the first array entry in \"items\"" + }, + "message": { + "type": "string", + "description": "A human-readable description of the cause of the error. This field may be presented as-is to a reader." + }, + "reason": { + "type": "string", + "description": "A machine-readable description of the cause of the error. If this value is empty there is no information available." + } + } + }, + "type": "array", + "description": "The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes." + }, + "uid": { + "type": "string", + "description": "UID of the resource. (when there is a single resource which can be described). More info: http://kubernetes.io/docs/user-guide/identifiers#uids" + } + } + }, + "message": { + "type": "string", + "description": "A human-readable description of the status of this operation." + }, + "metadata": { + "description": "ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.", + "properties": { + "continue": { + "type": "string", + "description": "continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response." + }, + "selfLink": { + "type": "string", + "description": "selfLink is a URL representing this object. Populated by the system. Read-only." + }, + "resourceVersion": { + "type": "string", + "description": "String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency" + } + } + } + } + }, + "pending": { + "items": { + "required": [ + "name" + ], + "description": "Initializer is information about an initializer that has not yet completed.", + "properties": { + "name": { + "type": "string", + "description": "name of the process that is responsible for initializing this object." + } + } + }, + "type": "array", + "description": "Pending is a list of initializers that must execute in order before this object is visible. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients.", + "x-kubernetes-patch-strategy": "merge", + "x-kubernetes-patch-merge-key": "name" + } + } + }, + "resourceVersion": { + "type": "string", + "description": "An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency" + }, + "generateName": { + "type": "string", + "description": "GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency" + }, + "creationTimestamp": { + "type": "string", + "format": "date-time" + }, + "annotations": { + "additionalProperties": true, + "type": "object", + "description": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations" + }, + "selfLink": { + "type": "string", + "description": "SelfLink is a URL representing this object. Populated by the system. Read-only." + }, + "uid": { + "type": "string", + "description": "UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids" + } + } + } + } +} + } + } + } + } + } + }, + "version": "v1alpha2" + } +} + + diff --git a/docs/install.md b/docs/install.md index bd08eb796f..8e56a85d59 100644 --- a/docs/install.md +++ b/docs/install.md @@ -17,7 +17,6 @@ Follow one of the methods below: ## With Helm * [Install Helm](https://docs.helm.sh) - * [Optionally, Install Ambassador](https://www.getambassador.io) * Install Seldon CRD. Set: * ```usage_metrics.enabled``` as appropriate. @@ -28,10 +27,12 @@ helm install seldon-core-crd --name seldon-core-crd --repo https://storage.googl * Install seldon-core components. Set * ```apife.enabled``` : (default true) set to ```false``` if you have installed Ambassador. * ```rbac.enabled``` : (default true) set to ```false``` if running an old Kubernetes cluster without RBAC. + * ```ambassador.enabled``` : (default false) set to ```true``` if you want to run with an Ambassador reverse proxy. ``` helm install seldon-core --name seldon-core --repo https://storage.googleapis.com/seldon-charts \ --set apife.enabled= \ - --set rbac.enabled= + --set rbac.enabled= \ + --set ambassador.enabled= ``` Notes @@ -69,4 +70,5 @@ Notes ### Install with kubeflow - * [Install Seldon as part of kubeflow.](https://github.com/kubeflow/kubeflow/blob/master/user_guide.md) \ No newline at end of file + * [Install Seldon as part of kubeflow.](https://github.com/kubeflow/kubeflow/blob/master/user_guide.md) + * Kubeflow presently runs 0.1 version of seldon-core. This will be updated to 0.2 in the near future. \ No newline at end of file diff --git a/engine/Dockerfile b/engine/Dockerfile index fe67d5145d..dd9c27299c 100644 --- a/engine/Dockerfile +++ b/engine/Dockerfile @@ -1,8 +1,8 @@ -FROM openjdk:8u151-jre-slim-stretch +FROM openjdk:8u171-jre-alpine3.7 ARG APP_VERSION=UNKOWN_VERSION -RUN apt-get update && apt-get install -y curl libblas-dev +#RUN apt-get update && apt-get install -y curl libblas-dev ADD /target/seldon-engine-${APP_VERSION}.jar app.jar diff --git a/engine/pom.xml b/engine/pom.xml index a0100d9867..079390eba1 100644 --- a/engine/pom.xml +++ b/engine/pom.xml @@ -10,7 +10,7 @@ io.seldon.engine seldon-engine - 0.2.1-SNAPSHOT + 0.2.1-SNAPSHOT-CRD jar engine diff --git a/helm-charts/seldon-core-crd/Chart.yaml b/helm-charts/seldon-core-crd/Chart.yaml index 8164cd8099..650cfff53e 100644 --- a/helm-charts/seldon-core-crd/Chart.yaml +++ b/helm-charts/seldon-core-crd/Chart.yaml @@ -6,4 +6,4 @@ keywords: name: seldon-core-crd sources: - https://github.com/SeldonIO/seldon-core -version: 0.2.1-SNAPSHOT +version: 0.2.1-SNAPSHOT-CRD diff --git a/helm-charts/seldon-core/Chart.yaml b/helm-charts/seldon-core/Chart.yaml index d0c810d417..4704574c80 100644 --- a/helm-charts/seldon-core/Chart.yaml +++ b/helm-charts/seldon-core/Chart.yaml @@ -6,4 +6,4 @@ keywords: name: seldon-core sources: - https://github.com/SeldonIO/seldon-core -version: 0.2.1-SNAPSHOT +version: 0.2.1-SNAPSHOT-CRD diff --git a/helm-charts/seldon-core/templates/_helpers.tpl b/helm-charts/seldon-core/templates/_helpers.tpl new file mode 100644 index 0000000000..4d52f2ac78 --- /dev/null +++ b/helm-charts/seldon-core/templates/_helpers.tpl @@ -0,0 +1,32 @@ +{{/* vim: set filetype=mustache: */}} +{{/* +Expand the name of the chart. +*/}} +{{- define "seldon.name" -}} +{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" -}} +{{- end -}} + +{{/* +Create a default fully qualified app name. +We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec). +If release name contains chart name it will be used as a full name. +*/}} +{{- define "seldon.fullname" -}} +{{- if .Values.fullnameOverride -}} +{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" -}} +{{- else -}} +{{- $name := default .Chart.Name .Values.nameOverride -}} +{{- if contains $name .Release.Name -}} +{{- .Release.Name | trunc 63 | trimSuffix "-" -}} +{{- else -}} +{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" -}} +{{- end -}} +{{- end -}} +{{- end -}} + +{{/* +Create chart name and version as used by the chart label. +*/}} +{{- define "seldon.chart" -}} +{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" -}} +{{- end -}} diff --git a/helm-charts/seldon-core/templates/ambassador.yaml b/helm-charts/seldon-core/templates/ambassador.yaml new file mode 100644 index 0000000000..a18ca14cd0 --- /dev/null +++ b/helm-charts/seldon-core/templates/ambassador.yaml @@ -0,0 +1,93 @@ +{{- if .Values.ambassador.enabled }} +--- +apiVersion: v1 +kind: Service +metadata: + labels: + service: ambassador + name: ambassador +{{- with .Values.ambassador.annotations }} + annotations: +{{ toYaml . | indent 4 }} +{{- end }} +spec: + selector: + service: ambassador + ports: + - name: http + protocol: TCP + port: 8080 + targetPort: 8080 + type: {{ .Values.ambassador.service_type }} +--- +apiVersion: v1 +kind: Service +metadata: + labels: + service: ambassador-admin + name: ambassador-admin +spec: + ports: + - name: ambassador-admin + port: 8877 + targetPort: 8877 + selector: + service: ambassador + type: NodePort +--- +apiVersion: extensions/v1beta1 +kind: Deployment +metadata: + name: ambassador +spec: + replicas: 1 + template: + metadata: + annotations: + sidecar.istio.io/inject: 'false' + labels: + service: ambassador + spec: + containers: + - image: {{ .Values.ambassador.image.name }} + name: ambassador + env: + - name: AMBASSADOR_SINGLE_NAMESPACE + value: 'true' + - name: AMBASSADOR_NAMESPACE + valueFrom: + fieldRef: + fieldPath: metadata.namespace + resources: +{{ toYaml .Values.ambassador.resources | indent 10 }} + ports: + - name: http + containerPort: 8080 + - name: https + containerPort: 443 + - name: admin + containerPort: 8877 + livenessProbe: + httpGet: + path: /ambassador/v0/check_alive + port: admin + initialDelaySeconds: 30 + periodSeconds: 3 + readinessProbe: + httpGet: + path: /ambassador/v0/check_ready + port: admin + initialDelaySeconds: 30 + periodSeconds: 3 + - image: {{ .Values.ambassador.statsd.image.name }} + name: statsd + ports: + - name: metrics + containerPort: 9102 + restartPolicy: Always +{{- if .Values.rbac.enabled }} + serviceAccountName: {{ .Values.rbac.service_account.name }} +{{- end }} + securityContext: + runAsUser: 8888 +{{- end }} diff --git a/helm-charts/seldon-core/templates/apife-deployment.json b/helm-charts/seldon-core/templates/apife-deployment.json deleted file mode 100644 index 8d1df23094..0000000000 --- a/helm-charts/seldon-core/templates/apife-deployment.json +++ /dev/null @@ -1,108 +0,0 @@ -{{- if .Values.apife.enabled }} -{ - "apiVersion": "v1", - "items": [ - { - "apiVersion": "extensions/v1beta1", - "kind": "Deployment", - "metadata": { - "name": "seldon-apiserver", - "namespace" : "{{ .Release.Namespace }}" - }, - "spec": { - "replicas": 1, - "template": { - "metadata": { - "annotations": { - "prometheus.io/path": "/prometheus", - "prometheus.io/port": "8080", - "prometheus.io/scrape": "true" - }, - "labels": { - "app": "seldon-apiserver-container-app", - "version": "1" - } - }, - "spec": { -{{- if .Values.rbac.enabled }} - "serviceAccountName": "seldon", -{{- end }} - "containers": [ - { - "env": [ - { - "name": "SELDON_ENGINE_KAFKA_SERVER", - "value": "kafka:9092" - }, - { - "name": "SELDON_CLUSTER_MANAGER_REDIS_HOST", - "value": "redis" - }, - { - "name": "SELDON_CLUSTER_MANAGER_POD_NAMESPACE", - "valueFrom": { - "fieldRef": { - "apiVersion": "v1", - "fieldPath": "metadata.namespace" - } - } - } - ], - "image": "seldonio/apife:{{ .Values.apife.image.tag }}", - "imagePullPolicy": "{{ .Values.apife.image.pull_policy }}", - "name": "seldon-apiserver-container", - "ports": [ - { - "containerPort": 8080, - "protocol": "TCP" - }, - { - "containerPort": 5000, - "protocol": "TCP" - } - ] - } - ] - } - } - } - }, - { - "apiVersion": "v1", - "kind": "Service", - "metadata": { - "labels": { - "app": "seldon-apiserver-container-app" - }, - "name": "seldon-apiserver" - }, - "spec": { - "ports": [ - { - "name": "http", - "port": 8080, - "protocol": "TCP", - "targetPort": 8080 - }, - { - "name": "grpc", - "port": 5000, - "protocol": "TCP", - "targetPort": 5000 - } - ], - "selector": { - "app": "seldon-apiserver-container-app" - }, - "sessionAffinity": "None", - "type": "{{ .Values.apife_service_type }}" - }, - "status": { - "loadBalancer": {} - } - } - ], - "kind": "List", - "metadata": {} -} -{{- end }} diff --git a/helm-charts/seldon-core/templates/apife-deployment.yaml b/helm-charts/seldon-core/templates/apife-deployment.yaml new file mode 100644 index 0000000000..7ecdd58a05 --- /dev/null +++ b/helm-charts/seldon-core/templates/apife-deployment.yaml @@ -0,0 +1,80 @@ +{{- if .Values.apife.enabled }} +--- +apiVersion: apps/v1beta1 +kind: Deployment +metadata: + labels: &Labels + app.kubernetes.io/name: {{ .Release.Name }} + app.kubernetes.io/component: seldon-core-apiserver + app: seldon-apiserver-container-app + chart: {{ template "seldon.chart" . }} + release: {{ .Release.Name }} + heritage: {{ .Release.Service }} + component: seldon-core + name: {{ .Release.Name }}-seldon-apiserver + namespace: {{ .Release.Namespace }} +spec: + replicas: 1 + selector: + matchLabels: *Labels + template: + metadata: + annotations: + prometheus.io/path: /prometheus + prometheus.io/port: "8080" + prometheus.io/scrape: "true" + labels: *Labels + spec: + containers: + - env: + - name: SELDON_ENGINE_KAFKA_SERVER + value: kafka:9092 + - name: SELDON_CLUSTER_MANAGER_REDIS_HOST + value: {{ .Release.Name }}-redis + - name: SELDON_CLUSTER_MANAGER_POD_NAMESPACE + valueFrom: + fieldRef: + apiVersion: v1 + fieldPath: metadata.namespace + image: {{ .Values.apife.image.name }} + imagePullPolicy: {{ .Values.apife.image.pull_policy }} + name: seldon-apiserver-container + ports: + - containerPort: 8080 + protocol: TCP + - containerPort: 5000 + protocol: TCP + dnsPolicy: ClusterFirst +{{- if .Values.rbac.enabled }} + serviceAccountName: {{ .Values.rbac.service_account.name }} +{{- end }} + securityContext: + runAsUser: 8888 + terminationGracePeriodSeconds: 30 +--- +apiVersion: v1 +kind: Service +metadata: + creationTimestamp: null + labels: + app.kubernetes.io/name: {{ .Release.Name }} + app.kubernetes.io/component: seldon-core-apiserver + app: seldon-apiserver-container-app + name: {{ .Release.Name }}-seldon-apiserver +spec: + ports: + - name: http + port: 8080 + protocol: TCP + targetPort: 8080 + - name: grpc + port: 5000 + protocol: TCP + targetPort: 5000 + selector: + app: seldon-apiserver-container-app + sessionAffinity: None + type: {{ .Values.apife.service_type }} +status: + loadBalancer: {} +{{- end }} diff --git a/helm-charts/seldon-core/templates/application.yaml b/helm-charts/seldon-core/templates/application.yaml new file mode 100644 index 0000000000..72db829c90 --- /dev/null +++ b/helm-charts/seldon-core/templates/application.yaml @@ -0,0 +1,37 @@ +{{- if .Values.application.enabled }} +--- +apiVersion: app.k8s.io/v1alpha1 +kind: Application +metadata: + name: "{{ .Release.Name }}" + namespace: "{{ .Release.Namespace }}" + annotations: + kubernetes-engine.cloud.google.com/icon: >- + data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAIIAAAA0CAYAAABGkOCVAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH4gYeDgQPVpMwugAADZ5JREFUeNrtnHl0XNV9xz9vnZE0mpFlyfIied8tyxZ4YbFDHMAEJy44LhRSmpyEQJNwSo4JnIbTNNASaBt6iks4Dg2UAKE0phAbXFxsxym2vGLLtixbllcZCcuSRrs0muUtt3+MPJY0b6zFhmPK+54zf7x5b35z3+9+7+/+ft9735OEEAIXX3QYsusDFwAuEVy4RHDhEsGFSwQXLhFcuERw4RLBhUsEFy4RXLhEcDF4qP8fbiIajWGYJsIWgABJQpYkdF1H09Qh2TNNE/sK2XOJ8BkgEo3xL//6CgfLjhLuimDZNpqmkJ6Wxl0rl7HyztsGTYLn17xG6cEjhDq7MC0LXVNJT09nxR23cffK210iXI2wTItTp89SX9+IqirdnQkNwWY+rj43eHuWRUXlac7V1qOpaoJswcYWqodgzyXCZwhFUZBlCUmSLn4nyyiyPER78d9esCf1+A83WXThVg0uXCK4cIngwtURBgEhBKFQF+fO11NReZrqmlq6QmEUWSYQyGTMmJFMHJ9P3ogcMjN96LrmaMcwTIJNzZypquH48dM0NbUCMHx4FlOnTmTqpPFkZ2ddkTq+ozPEyZNnOVhWQbCxmfQ0L0WF0ykqmo7How+5jG2oD3KqqpqTpz6mtbUNIWBYlp/Jk8YxZcp4RuQMx+v1pGxTW1sH0WgMy7aRZRmPrpLp8xEIZNLS2sbxE1WUHa6kpaUNf6aPoqLpFM6aQlYggCRBR2cXqiKhqiqqqvZKnj9VIti2zaYtJbyzfhNHj53EtmxUVUGSJRDx85ZlgSQxckQOswun87ePP5Tk7OMnzvD2uv+hZGcpjY3N6LqG3J3x27aNYVoMz87iliU3sOKOW5k0cdyQ27y/tJyXXllLWfkxZFlGVmSELfjtf65n/Nh8/uKbd8Ig9vMKIdi1+wDr3ttC6aFyOjtCaFp3+yWwLRvDNPFlpDPv2iLuXH4L1y8sTtzfBRvPPf8K23fsixPBsuJE8Ojk54/iG3+ylDff2kDV2Ro0VUGWZSxb8Oob7zBp4lh+8OA3uWnxQsrKKujoDOHLSOe6hcWDGjSXRYQXXnyD9e9txrQs0tO8/Y7CDRu38vhj38fTY1Ds2XuQZ597iYZgM5qmEghkJv02DYjFYqzfsIUDZUf58Y/u59riwkG3t+zwMf7umedpbesgIyO91zmv10OwsZnn17yGrmnIsjIgmy//5i3eXvcB4XAEVVXw+53bLwTs+egg5UeOc/fKZXz7vhUoitJNBAh1hrEsqztiagmCnDt3nhdefB3DMMn0ZfS26/VQ39DI6l++Sm7OcIrnziQcjiIQCU3lU88RSnbu54PN25AkKSG89IdxY0eTkZGWOK6rC/LEU6tpaW1H17VLhjJJkvB4dOrqgrz8m7dobGwZXPSybJ574VVCoTC6pqXUD4QQRGMxBhJV/+v3G/mP372LYRhomtpP+0HXNAzD4M217/HHbXt6n++jg1y4ZyHAtkWCNEkdKMs0Nrew9cPdeDwecnKGkZuTPahp4bKIsG37XiKRqGOHaZqKpmlomoqqqSiKQixmcPvSJb2u/YdnXyRmWg4OAK/XS0ZGmqNzKo6dpPRg+aDau33XfurqgykdpCgyiqIw0Mc8GptaeO2NdSiK4mhTURRU1dmeaVq8/sY6OjpDAw/dqpK67bLM0YoTGIbx2SaL7R2dBBubHXOGZV9dwi1LbiAjI41IJEpTUyuf1NZRV9/Iffcu75UXnDhVhexwcxMnjOXxx37A6FEjeHb1S2zaXNIryRQC9u0vZ8lN1w+4zaWl5RgxZ0eNzMvlq7d9CV3T2LSlhNNnqvsNrf+98Y9EozHnyDcun6/ddhOSLLNh41aqqmp6jWhFkTl5+iyHDlWweNH8flXTxTfOY9bMqQSDTfz+3S0YRqwXKSRJoqW1Hcu2P1sixKIGMQen2kLwpUXzKZ47s18be/YdwjQtxxu/7dbFTBifD8Bd31jGlj/sTAqHp6uqMU1zQO0NdYWprWtACJE0qjRV5Z67vs7yr30FgNmF03j4kb/Htu2UI9AwTCoqT2FZydFMVVX+8v57WDh/DgAzpk3k+3/1syQbuqayeeuOfomQFcjkb37yUGLA1J5v4H+37UbrO71d5vNqQ5oa4qE/mUOqovD0P63hZ0+tZlvJXoxLdNTH1bXxisLBxtyiGYnjQGZGUoiNj4A27AGOgFCoi/b2TsdzHo/O7MKpPfKYMYwZnXdJ201NLTQ3t6boOB+FM6ckjscWjGFswSgsy04izKHDx/rvIFnuFTXz8nK6l8evAh0hEMhkxIjhUOHs9O0l+/hw2140TeXG667hnru/zrSpk1AUubvmjtLR0ZnS/o5dBzhcfgIhBG3tHYnO75lDWJaNIL4g1B/C4QiRSMTxnK5r5AzPvmgbKaXW0bMC6ugIJUUDIQSBgL9XRaIoMnl5uVTX1PYZdxKhUBexqIHm0T6/gtLSmxexY9d+DMNMkXjFM/APS/ayfec+li+7mQe++2f4/T6iUYNo1Hm+jsZivPTK7xIR4EK10NfhXo8+4MzYMExiKRIpWZFJ61X6in6jbDQWIxpzzg+8Hk9SNeDLSEuSJiQpXg20trXHB9XnVWJeMH8OD373nu7dPFbKku+CuLLuvc0884s13R1pIy4Rej0eHa/Xg9frcVT6hAB/INMx0XQWvkT37iWHNiLFBbBBCmmpwrMkyUn2Uy1fC8Qlp8/PzVrDijuW8us1TzNp4lii0VjKefXCqN615wCbt5Tg9Xp6KWtO5ZVhmCk/0ViM3JzslLV18jyburOFEAPONXomtBemub6wbCups03LTklC7xAl7atqrUGSJGZOn8wr//aPHCo7xob3t1J2pJKurrBjaaWqKhs3b2PprYtTau6apvLwQ99m/NgxKcshYdvkjhiOrmspo1HfPEDX9JQdF+4Kk5npS3RPf/B6PHg9HtpEZ5Lw1DcXEbagoz2UdJ0QAlmWyRoW4Gp4RcUV26E0d84M5s6ZgWVZ7N57kDfXbuDEyaqkbL+m5nwi4UwVdru6wszpUTlcLtLSvKSne1OWwvUNTT2IIIiEI5ckhN/vw+/3Ud/Q2Os6SZJobmmjtbWdrCx/nGiWxSfnzidFQCEEOTnZKLL8qVQBn+nUsL+0PKksUxSFRTfM4/qFxY7JnC3sbtGoANVBmrYsm/Ub/sD2ko8S5aVpWhyrPM0v17xO6cGjg25npi+DrIDf8VwkEmXnrtLE8aHDx6j5pC5l6AfIzckmN8c5wevs7GLn7ov29h84Ql19YxIRDNNkwbwirhYMOSJs37GPf179MpZtMTIvl7H5o8gKBJBliYZgE2WHK5PmXiEEeblxB16/sJjfvvmuo5bQ2NjM07/4FWlp8RDcFY505wcGJbv28/KvnsGfGMH9w+v1kJ8/ktKDR5LCsGXbrH3nfSoqT6HrGvsPlF+SBBdwbfEs9pWWJU1NlmXx639fS1l5JbIssX3HPkfNxbZsbl960+ebCLZts2nzdjo747V0VVUNZ85U9yr5nJJBy7JYuLA4IdwUz5nBjt2ljptMTdOko8Oko6O3Ht/S0sY76zbxnW+tHFSbb7zuWj7YvN1xfSQajfHR/rKEgDOQsnTZ7V9m7dvv0xBsSrq+MxRi89YdIOKldN/zlmWxcMFcJk8ad9UQYUhTQ119kNq6hl5zoyzL3dm04kgCwzAZnj2Mu1ZcfC7g0VXfY8yoPGIpanLH5M6yKDtcQSQaHVSbrymeReHMqSkXZmRZRpbj2sdANHuPrvPIj+7H4/E4St2KLDtGFtu2ycoK8J1v/emQN8FcNUQwTItwJEo4Ek2STp3Ks3A4wsi8HJ746cP4fOk95Fg/Tz2xitmF0+kKR/q1ZVkWoa4wuq5jxMxe39u2QIiLH9u2kzr00VXfY/Lk8YS6wimFJ49H55q5hcRiRi97loN2sGBeET/9yQ/Jy8slHI5csgwVQhDq6iI3J5u//vGDFBVOS5oqbNtOuge7j0+ELRyuG3wJnETcJ5988slBS8x+H9ctmEsgkElrSxutbe0JR9i2ndABotEYWVl+li/7Co898gCTHXYWDRsWYPGiBYzIyeZcbR3BYBNG9+Nmtm1hGBbRaBRVVZg6ZQI/fPDPue/eO8nMzEg4sKy8kvb2zkRk0j06fn8mC+fPZXYPh2ekp7HohnlEwhGOn6giGo0hhB1XHmMGs2ZN5edPrGLM6DyOnziD3b1I5fFoBPx+5s8rYs7s6b3aP7ZgNF9evABNUzlXW09TcytWd6fG228Qi5kMz87i3ruW8+iqB5g6ZUKSHyoqT9HY2IKQLu5d8Pt9TJxQwK03L0pcV119jjNnaxJrEKqm4vOlM2FcAbcsuWGoW/ls6Uq8Z7G5uY3a8/Wcq62jvaMTSZLJCmQyYXwBo0fnkZZCM0jWBwTn64OcqaohGGzEMC18vnQKxoyiIH8kWVmBS0Qpk1g0PoplRSbNqyepfD3R1NzK0aMnqA82kZ6exoxpk5g4oaCnEkQ4Eo9SsizjTdORpUsH0JhhUFtbz+mqGlpa2kBA9rAAEybkU5A/yrFK6lsxXRDmJFnCo2uOvxFCEI5EsS07TprLfybTkNwXbrrAfeGmiysiKLlwieDCJYILlwguXCK4cIngwiWCC5cILr5IkFQg5vrhCw/z/wDVfjI+TMf0ygAAAABJRU5ErkJggg== + marketplace.cloud.google.com/deploy-info: '{partner_id: "seldon", product_id: "seldon-core", partner_name: "SELDON"}' + labels: + app.kubernetes.io/name: "{{ .Release.Name }}" +spec: + type: Seldon-Core + version: '{{ .Chart.Version }}' + description: |- + Machine learning deployment + + # Support + Visit [Seldon-Core on Github](https://github.com/SeldonIO/seldon-core). + maintainers: + - name: Seldon + url: https://seldon.io + email: dev@seldon.io + links: + - description: Getting Started + url: https://github.com/SeldonIO/seldon-core + selector: + matchLabels: + app.kubernetes.io/name: "{{ .Release.Name }}" + componentKinds: + - group: extensions/v1beta1 + kind: Deployment + - group: v1 + kind: Service +{{- end }} diff --git a/helm-charts/seldon-core/templates/cluster-manager-deployment.yaml b/helm-charts/seldon-core/templates/cluster-manager-deployment.yaml index 9e446ca118..4f9886fe48 100644 --- a/helm-charts/seldon-core/templates/cluster-manager-deployment.yaml +++ b/helm-charts/seldon-core/templates/cluster-manager-deployment.yaml @@ -1,41 +1,48 @@ --- -apiVersion: v1 -items: -- apiVersion: extensions/v1beta1 - kind: Deployment - metadata: - name: seldon-cluster-manager - namespace: {{ .Release.Namespace }} - spec: - replicas: 1 - template: - metadata: - labels: - app: seldon-cluster-manager-server - spec: +apiVersion: extensions/v1beta1 +kind: Deployment +metadata: + labels: &Labels + app.kubernetes.io/name: {{ .Release.Name }} + app.kubernetes.io/component: seldon-core-operator + app: seldon-cluster-manager-server + chart: {{ template "seldon.chart" . }} + release: {{ .Release.Name }} + heritage: {{ .Release.Service }} + component: seldon-core + name: {{ .Release.Name }}-seldon-cluster-manager + namespace: {{ .Release.Namespace }} +spec: + replicas: 1 + selector: + matchLabels: *Labels + template: + metadata: + labels: *Labels + spec: {{- if .Values.rbac.enabled }} - serviceAccountName: seldon + serviceAccountName: {{ .Values.rbac.service_account.name }} {{- end }} - containers: - - env: - - name: JAVA_OPTS - value: {{ .Values.cluster_manager.java_opts }} - - name: SPRING_OPTS - value: {{ .Values.cluster_manager.spring_opts }} - - name: SELDON_CLUSTER_MANAGER_REDIS_HOST - value: redis - - name: ENGINE_CONTAINER_IMAGE_AND_VERSION - value: seldonio/engine:{{ .Values.engine.image.tag }} - - name: SELDON_CLUSTER_MANAGER_POD_NAMESPACE - valueFrom: - fieldRef: - apiVersion: v1 - fieldPath: metadata.namespace - image: seldonio/cluster-manager:{{ .Values.cluster_manager.image.tag }} - imagePullPolicy: {{ .Values.cluster_manager.image.pull_policy }} - name: seldon-cluster-manager-container - ports: - - containerPort: 8080 - protocol: TCP -kind: List -metadata: {} + securityContext: + runAsUser: 8888 + containers: + - env: + - name: JAVA_OPTS + value: {{ .Values.cluster_manager.java_opts }} + - name: SPRING_OPTS + value: {{ .Values.cluster_manager.spring_opts }} + - name: SELDON_CLUSTER_MANAGER_REDIS_HOST + value: redis + - name: ENGINE_CONTAINER_IMAGE_AND_VERSION + value: {{ .Values.engine.image.name }} + - name: SELDON_CLUSTER_MANAGER_POD_NAMESPACE + valueFrom: + fieldRef: + apiVersion: v1 + fieldPath: metadata.namespace + image: {{ .Values.cluster_manager.image.name }} + imagePullPolicy: {{ .Values.cluster_manager.image.pull_policy }} + name: seldon-cluster-manager-container + ports: + - containerPort: 8080 + protocol: TCP diff --git a/helm-charts/seldon-core/templates/rbac.yaml b/helm-charts/seldon-core/templates/rbac.yaml index 82509f7087..2838d1deae 100644 --- a/helm-charts/seldon-core/templates/rbac.yaml +++ b/helm-charts/seldon-core/templates/rbac.yaml @@ -1,26 +1,99 @@ {{- if .Values.rbac.enabled }} +{{- if .Values.rbac.service_account.create }} --- apiVersion: v1 -items: -- apiVersion: v1 - kind: ServiceAccount - metadata: - name: seldon +kind: ServiceAccount +metadata: + name: {{ .Values.rbac.service_account.name }} + namespace: {{ .Release.Namespace }} +{{- end }} +{{- if .Values.rbac.rolebinding.create }} +--- +apiVersion: rbac.authorization.k8s.io/v1beta1 +kind: Role +metadata: + name: seldon-local + namespace: {{ .Release.Namespace }} +rules: +- apiGroups: ["*"] + resources: + - deployments + - services + verbs: ["*"] +- apiGroups: + - machinelearning.seldon.io + resources: ["*"] + verbs: ["*"] +--- +apiVersion: rbac.authorization.k8s.io/v1beta1 +kind: ClusterRole +metadata: + name: seldon-crd + namespace: {{ .Release.Namespace }} +rules: +- apiGroups: + - apiextensions.k8s.io + resources: + - customresourcedefinitions + verbs: ["create"] +--- +apiVersion: rbac.authorization.k8s.io/v1 +kind: RoleBinding +metadata: + name: seldon + namespace: {{ .Release.Namespace }} +roleRef: + apiGroup: rbac.authorization.k8s.io + kind: Role + name: seldon-local +subjects: + - kind: ServiceAccount + name: {{ .Values.rbac.service_account.name }} namespace: {{ .Release.Namespace }} -- apiVersion: rbac.authorization.k8s.io/v1 - kind: RoleBinding - metadata: - name: seldon +--- +apiVersion: rbac.authorization.k8s.io/v1 +kind: ClusterRoleBinding +metadata: + name: seldon + namespace: {{ .Release.Namespace }} +roleRef: + apiGroup: rbac.authorization.k8s.io + kind: ClusterRole + name: seldon-crd +subjects: + - kind: ServiceAccount + name: {{ .Values.rbac.service_account.name }} namespace: {{ .Release.Namespace }} - roleRef: - apiGroup: rbac.authorization.k8s.io - kind: ClusterRole - name: cluster-admin - subjects: - - kind: ServiceAccount - name: seldon - namespace: {{ .Release.Namespace }} -kind: List -metadata: {} -namespace: {{ .Release.Namespace }} +--- +apiVersion: rbac.authorization.k8s.io/v1beta1 +kind: Role +metadata: + name: ambassador +rules: +- apiGroups: [""] + resources: + - services + verbs: ["get", "list", "watch"] +- apiGroups: [""] + resources: + - configmaps + verbs: ["create", "update", "patch", "get", "list", "watch"] +- apiGroups: [""] + resources: + - secrets + verbs: ["get", "list", "watch"] +--- +apiVersion: rbac.authorization.k8s.io/v1beta1 +kind: RoleBinding +metadata: + name: ambassador +roleRef: + apiGroup: rbac.authorization.k8s.io + kind: Role + name: ambassador +subjects: +- kind: ServiceAccount + name: {{ .Values.rbac.service_account.name }} + namespace: {{ .Release.Namespace }} +{{- end }} {{- end }} diff --git a/helm-charts/seldon-core/templates/redis-deployment.yaml b/helm-charts/seldon-core/templates/redis-deployment.yaml index f444a32c8b..c0a5a0f36c 100644 --- a/helm-charts/seldon-core/templates/redis-deployment.yaml +++ b/helm-charts/seldon-core/templates/redis-deployment.yaml @@ -1,39 +1,49 @@ --- +apiVersion: extensions/v1beta1 +kind: Deployment +metadata: + labels: &Labels + app.kubernetes.io/name: {{ .Release.Name }} + app.kubernetes.io/component: seldon-core-redis + app: {{ .Release.Name }}-redis-app + chart: {{ template "seldon.chart" . }} + release: {{ .Release.Name }} + heritage: {{ .Release.Service }} + component: seldon-core + name: {{ .Release.Name }}-redis + namespace: {{ .Release.Namespace }} +spec: + replicas: 1 + selector: + matchLabels: *Labels + template: + metadata: + labels: *Labels + spec: + containers: + - image: {{ .Values.redis.image.name }} + name: redis-container + ports: + - containerPort: 6379 + protocol: TCP +--- apiVersion: v1 -items: -- apiVersion: extensions/v1beta1 - kind: Deployment - metadata: - name: redis - namespace: {{ .Release.Namespace }} - spec: - replicas: 1 - template: - metadata: - labels: - app: redis-app - spec: - containers: - - image: redis:{{ .Values.redis.image.tag }} - name: redis-container - ports: - - containerPort: 6379 - protocol: TCP -- apiVersion: v1 - kind: Service - metadata: - name: redis - spec: - ports: - - port: 6379 - protocol: TCP - targetPort: 6379 - selector: - app: redis-app - sessionAffinity: None - type: ClusterIP - status: - loadBalancer: {} -kind: List -metadata: {} +kind: Service +metadata: + labels: + app.kubernetes.io/name: {{ .Release.Name }} + app.kubernetes.io/component: seldon-core-redis + name: {{ .Release.Name }}-redis +spec: + ports: + - port: 6379 + protocol: TCP + targetPort: 6379 + selector: + app: {{ .Release.Name }}-redis-app + sessionAffinity: None + type: ClusterIP +status: + loadBalancer: {} + diff --git a/helm-charts/seldon-core/values.yaml b/helm-charts/seldon-core/values.yaml index e32977dcc2..3757cf40a4 100644 --- a/helm-charts/seldon-core/values.yaml +++ b/helm-charts/seldon-core/values.yaml @@ -1,20 +1,51 @@ apife: enabled: true image: + name: seldonio/apife:0.2.1-SNAPSHOT-CRD pull_policy: IfNotPresent - tag: 0.2.1-SNAPSHOT -apife_service_type: NodePort + service_type: NodePort +application: + enabled: false cluster_manager: image: + name: seldonio/cluster-manager:0.2.1-SNAPSHOT-CRD pull_policy: IfNotPresent - tag: 0.2.1-SNAPSHOT java_opts: '' spring_opts: '' engine: image: - tag: 0.2.1-SNAPSHOT + name: seldonio/engine:0.2.1-SNAPSHOT-CRD rbac: enabled: true + rolebinding: + create: true + service_account: + create: true + name: seldon redis: image: - tag: 4.0.1 + name: redis:4.0.1 +ambassador: + enabled: false + service_type: NodePort + image: + name: quay.io/datawire/ambassador:0.35.1 + statsd: + image: + name: datawire/prom-statsd-exporter:0.6.0 + annotations: + getambassador.io/config: | + --- + apiVersion: ambassador/v0 + kind: Module + name: ambassador + config: + service_port: 8080 + resources: + limits: + cpu: 1 + memory: 400Mi + requests: + cpu: 200m + memory: 128Mi + \ No newline at end of file diff --git a/notebooks/advanced_graphs.ipynb b/notebooks/advanced_graphs.ipynb index 46252e52ac..cab2ef4b69 100644 --- a/notebooks/advanced_graphs.ipynb +++ b/notebooks/advanced_graphs.ipynb @@ -66,8 +66,7 @@ "source": [ "!helm install ../helm-charts/seldon-core --name seldon-core \\\n", " --set cluster_manager.rbac=true \\\n", - " --set cluster_manager_service_type=LoadBalancer \\\n", - " --set apife_service_type=LoadBalancer \\\n", + " --set apife.service_type=LoadBalancer \\\n", " --namespace graphs" ] }, @@ -77,7 +76,7 @@ "metadata": {}, "outputs": [], "source": [ - "!kubectl get svc -n seldon seldon-apiserver -n graphs" + "!kubectl get svc -l app=seldon-apiserver-container-app -n graphs" ] }, { @@ -90,9 +89,7 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [ "!cp ../proto/prediction.proto ./proto\n", @@ -102,9 +99,7 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [ "from visualizer import get_graph\n", @@ -114,9 +109,7 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [ "import requests\n", @@ -130,7 +123,7 @@ " from subprocess import getoutput # python 3\n", "\n", "NAMESPACE=\"graphs\"\n", - "SELDON_API_IP=getoutput(\"kubectl get svc -n \"+NAMESPACE+\" seldon-apiserver -o jsonpath='{.status.loadBalancer.ingress[0].ip}'\")\n", + "SELDON_API_IP=getoutput(\"kubectl get svc -n \"+NAMESPACE+\" -l app=seldon-apiserver-container-app -o jsonpath='{.items[0].status.loadBalancer.ingress[0].ip}'\")\n", "\n", "def get_token():\n", " payload = {'grant_type': 'client_credentials'}\n", @@ -257,9 +250,7 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [ "get_graph(\"resources/random_ab_test.json\")" @@ -277,9 +268,7 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [ "json.load(open(\"./resources/random_ab_test.json\",'r')).get(\"spec\").get(\"predictors\")[0].get(\"graph\")" @@ -296,9 +285,7 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [ "!kubectl apply -f resources/random_ab_test.json -n graphs" @@ -307,9 +294,7 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [ "!kubectl get seldondeployments seldon-deployment-example -o jsonpath='{.status}' -n graphs" @@ -318,9 +303,7 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [ "rest_request()" @@ -329,9 +312,7 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [ "grpc_request()" @@ -340,9 +321,7 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [ "!kubectl delete -f resources/random_ab_test.json -n graphs" @@ -358,9 +337,7 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [ "get_graph(\"resources/ensemble.json\")" @@ -378,9 +355,7 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [ "json.load(open(\"./resources/ensemble.json\",'r')).get(\"spec\").get(\"predictors\")[0].get(\"graph\")" @@ -389,9 +364,7 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [ "!kubectl apply -f resources/ensemble.json -n graphs" @@ -400,9 +373,7 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [ "!kubectl get seldondeployments seldon-deployment-example -o jsonpath='{.status}' -n graphs" @@ -411,9 +382,7 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [ "rest_request()" @@ -422,9 +391,7 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [ "grpc_request()" @@ -433,9 +400,7 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [ "!kubectl delete -f resources/ensemble.json -n graphs" @@ -451,9 +416,7 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [ "get_graph(\"resources/feature_transform.json\")" @@ -473,9 +436,7 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [ "json.load(open(\"./resources/feature_transform.json\",'r')).get(\"spec\").get(\"predictors\")[0].get(\"graph\")" @@ -484,9 +445,7 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [ "!kubectl apply -f resources/feature_transform.json -n graphs" @@ -495,9 +454,7 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [ "!kubectl get seldondeployments seldon-deployment-example -o jsonpath='{.status}' -n graphs" @@ -506,9 +463,7 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [ "rest_request()" @@ -517,9 +472,7 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [ "grpc_request()" @@ -528,9 +481,7 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [ "!kubectl delete -f resources/feature_transform.json -n graphs" @@ -632,7 +583,6 @@ "cell_type": "code", "execution_count": null, "metadata": { - "collapsed": true, "scrolled": false }, "outputs": [], @@ -650,9 +600,7 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [ "!kubectl apply -f resources/complex_graph.json -n graphs" @@ -661,9 +609,7 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [ "!kubectl get seldondeployments seldon-deployment-example -o jsonpath='{.status}' -n graphs" @@ -672,9 +618,7 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [ "rest_request()" @@ -683,9 +627,7 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [ "grpc_request()" @@ -695,7 +637,6 @@ "cell_type": "code", "execution_count": null, "metadata": { - "collapsed": true, "scrolled": true }, "outputs": [], @@ -714,7 +655,6 @@ "cell_type": "code", "execution_count": null, "metadata": { - "collapsed": true, "scrolled": true }, "outputs": [], @@ -725,9 +665,7 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [ "!helm delete seldon-core-crd --purge" @@ -736,9 +674,7 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [] } diff --git a/notebooks/epsilon_greedy_gcp.ipynb b/notebooks/epsilon_greedy_gcp.ipynb index a41cf858bb..87faf2a093 100644 --- a/notebooks/epsilon_greedy_gcp.ipynb +++ b/notebooks/epsilon_greedy_gcp.ipynb @@ -33,9 +33,7 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [ "!kubectl -n kube-system create sa tiller\n", @@ -55,9 +53,7 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [ "!kubectl create namespace mab" @@ -66,25 +62,21 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [ "!helm install ../helm-charts/seldon-core --name seldon-core \\\n", - " --set apife_service_type=LoadBalancer \\\n", + " --set apife.service_type=LoadBalancer \\\n", " --namespace mab" ] }, { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [ - "!kubectl get svc -n seldon seldon-apiserver -n mab" + "!kubectl get svc -l app=seldon-apiserver-container-app -n mab" ] }, { @@ -97,9 +89,7 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [ "from visualizer import get_graph\n", @@ -116,7 +106,7 @@ "%matplotlib inline\n", "\n", "NAMESPACE=\"mab\"\n", - "SELDON_API_IP=getoutput(\"kubectl get svc -n \"+NAMESPACE+\" seldon-apiserver -o jsonpath='{.status.loadBalancer.ingress[0].ip}'\")\n", + "SELDON_API_IP=getoutput(\"kubectl get svc -n \"+NAMESPACE+\" -l app=seldon-apiserver-container-app -o jsonpath='{.items[0].status.loadBalancer.ingress[0].ip}'\")\n", "\n", "def get_token():\n", " payload = {'grant_type': 'client_credentials'}\n", @@ -168,9 +158,7 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [ "get_graph(\"resources/epsilon_greedy.json\")" @@ -188,9 +176,7 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [ "!jq .spec.predictors[0].graph resources/epsilon_greedy.json" @@ -212,7 +198,6 @@ "cell_type": "code", "execution_count": null, "metadata": { - "collapsed": true, "scrolled": false }, "outputs": [], @@ -223,9 +208,7 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [ "!kubectl get seldondeployments seldon-deployment-example -o jsonpath=\"{.status}\" -n mab" @@ -248,9 +231,7 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [ "request = {\n", @@ -271,9 +252,7 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [ "rest_request(request)" @@ -292,9 +271,7 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [ "results = {0:0,1:0,2:0}\n", @@ -328,9 +305,7 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [ "response = rest_request(request)\n", @@ -347,9 +322,7 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [ "send_feedback_rest(request,response,reward=0)" @@ -368,7 +341,6 @@ "cell_type": "code", "execution_count": null, "metadata": { - "collapsed": true, "scrolled": false }, "outputs": [], @@ -422,9 +394,7 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [ "request = {\n", @@ -449,9 +419,7 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [ "response = rest_request(request)\n", @@ -461,9 +429,7 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [ "send_feedback_rest(request,response,reward=0.4)" @@ -486,9 +452,7 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [ "!kubectl delete -f resources/epsilon_greedy.json -n mab" @@ -497,9 +461,7 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [ "!helm delete seldon-core --purge" @@ -508,9 +470,7 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [ "!helm delete seldon-core-crd --purge" @@ -519,9 +479,7 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [] } diff --git a/notebooks/helm_minikube_ambassador.ipynb b/notebooks/helm_minikube_ambassador.ipynb new file mode 100644 index 0000000000..53da81f45d --- /dev/null +++ b/notebooks/helm_minikube_ambassador.ipynb @@ -0,0 +1,607 @@ +{ + "cells": [ + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Deploying Machine Learning Models Minikube with RBAC using kubectl\n", + "This demo shows how you can interact directly with kubernetes using kubectl to create and manage runtime machine learning models. It uses Minikube as the target Kubernetes cluster.\n", + "\"predictor" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "## Prerequistes\n", + "You will need\n", + " - [Git clone of Seldon Core](https://github.com/SeldonIO/seldon-core)\n", + " - [Helm](https://github.com/kubernetes/helm)\n", + " - [Minikube](https://github.com/kubernetes/minikube) version v0.24.0 or greater\n", + " - [python grpc tools](https://grpc.io/docs/quickstart/python.html)\n" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Create Cluster\n", + "\n", + "Start minikube and ensure custom resource validation is activated and there is 5G of memory. \n", + "\n", + "**2018-06-13** : At present we find the most stable version of minikube across platforms is 0.25.2 as there are issues with 0.26 and 0.27 on some systems. We also find the default VirtualBox driver can be problematic on some systems to we suggest using the [KVM2 driver](https://github.com/kubernetes/minikube/blob/master/docs/drivers.md#kvm2-driver).\n", + "\n", + "Your start command would then look like:\n", + "```\n", + "minikube start --vm-driver kvm2 --memory 4096 --feature-gates=CustomResourceValidation=true --extra-config=apiserver.Authorization.Mode=RBAC\n", + "```" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Setup" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "!kubectl create namespace seldon" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "!kubectl create clusterrolebinding kube-system-cluster-admin --clusterrole=cluster-admin --serviceaccount=kube-system:default" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Install Helm" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "!kubectl -n kube-system create sa tiller\n", + "!kubectl create clusterrolebinding tiller --clusterrole cluster-admin --serviceaccount=kube-system:tiller\n", + "!helm init --service-account tiller" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "Label the node to allow load testing to run on it" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "!kubectl label nodes `kubectl get nodes -o jsonpath='{.items[0].metadata.name}'` role=locust --overwrite" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "## Start seldon-core" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "Install the custom resource definition" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "!helm install ../helm-charts/seldon-core-crd --name seldon-core-crd --set usage_metrics.enabled=true" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "!helm install ../helm-charts/seldon-core --name seldon-core --namespace seldon --set ambassador.enabled=true" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "Install prometheus and grafana for analytics" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "!helm install ../helm-charts/seldon-core-analytics --name seldon-core-analytics \\\n", + " --set grafana_prom_admin_password=password \\\n", + " --set persistence.enabled=false \\\n", + " --namespace seldon" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "Check all services are running before proceeding." + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "!kubectl get pods -n seldon" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "## Set up REST and gRPC methods\n", + "\n", + "**Ensure you port forward ambassador**:\n", + "\n", + "```\n", + "kubectl port-forward $(kubectl get pods -n seldon -l service=ambassador -o jsonpath='{.items[0].metadata.name}') -n seldon 8004:8080\n", + "```" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "Install gRPC modules for the prediction protos." + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "!cp ../proto/prediction.proto ./proto\n", + "!python -m grpc.tools.protoc -I. --python_out=. --grpc_python_out=. ./proto/prediction.proto" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "Illustration of both REST and gRPC requests. " + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "import requests\n", + "from requests.auth import HTTPBasicAuth\n", + "from proto import prediction_pb2\n", + "from proto import prediction_pb2_grpc\n", + "import grpc\n", + "\n", + "AMBASSADOR_API=\"localhost:8004\"\n", + "\n", + "def rest_request(deploymentName):\n", + " payload = {\"data\":{\"names\":[\"a\",\"b\"],\"tensor\":{\"shape\":[2,2],\"values\":[0,0,1,1]}}}\n", + " response = requests.post(\n", + " \"http://\"+AMBASSADOR_API+\"/seldon/\"+deploymentName+\"/api/v0.1/predictions\",\n", + " json=payload)\n", + " print(response.status_code)\n", + " print(response.text) \n", + " \n", + "def rest_request_auth(deploymentName,username,password):\n", + " payload = {\"data\":{\"names\":[\"a\",\"b\"],\"tensor\":{\"shape\":[2,2],\"values\":[0,0,1,1]}}}\n", + " response = requests.post(\n", + " \"http://\"+AMBASSADOR_API+\"/seldon/\"+deploymentName+\"/api/v0.1/predictions\",\n", + " json=payload,\n", + " auth=HTTPBasicAuth(username, password))\n", + " print(response.status_code)\n", + " print(response.text)\n", + "\n", + "def grpc_request(deploymentName):\n", + " datadef = prediction_pb2.DefaultData(\n", + " names = [\"a\",\"b\"],\n", + " tensor = prediction_pb2.Tensor(\n", + " shape = [3,2],\n", + " values = [1.0,1.0,2.0,3.0,4.0,5.0]\n", + " )\n", + " )\n", + " request = prediction_pb2.SeldonMessage(data = datadef)\n", + " channel = grpc.insecure_channel(AMBASSADOR_API)\n", + " stub = prediction_pb2_grpc.SeldonStub(channel)\n", + " metadata = [('seldon',deploymentName)]\n", + " response = stub.Predict(request=request,metadata=metadata)\n", + " print(response)" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Integrating with Kubernetes API" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "## Validation" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "Using OpenAPI Schema certain basic validation can be done before the custom resource is accepted." + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "!kubectl create -f resources/model_invalid1.json -n seldon" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "## Normal Operation\n", + "A simple example is shown below we use a single prepacked model for illustration. The spec contains a set of predictors each of which contains a ***componentSpec*** which is a Kubernetes [PodTemplateSpec](https://kubernetes.io/docs/api-reference/v1.9/#podtemplatespec-v1-core) alongside a ***graph*** which describes how components fit together." + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "!pygmentize resources/model.json" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "## Create Seldon Deployment" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "Deploy the runtime graph to kubernetes." + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "!kubectl apply -f resources/model.json -n seldon" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "!kubectl get seldondeployments -n seldon" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "!kubectl describe seldondeployments seldon-deployment-example -n seldon" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "Get the status of the SeldonDeployment. **When ready the replicasAvailable should be 1**." + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "!kubectl get seldondeployments seldon-deployment-example -o jsonpath='{.status}' -n seldon" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "## Get predictions" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "#### REST Request" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "rest_request(\"seldon-deployment-example\")" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "#### gRPC Request" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "grpc_request(\"seldon-deployment-example\")" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "## Update deployment with canary" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "We will change the deployment to add a \"canary\" deployment. This illustrates:\n", + " - Updating a deployment with no downtime\n", + " - Adding an extra predictor to run alongside th exsting predictor.\n", + " \n", + " You could manage different traffic levels by controlling the number of replicas of each." + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "!pygmentize resources/model_with_canary.json" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "!kubectl apply -f resources/model_with_canary.json -n seldon" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "Check the status of the deployments. Note: **Might need to run several times until replicasAvailable is 1 for both predictors**." + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "!kubectl get seldondeployments seldon-deployment-example -o jsonpath='{.status}' -n seldon" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "#### REST Request" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "rest_request(\"seldon-deployment-example\")" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "#### gRPC request" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "grpc_request(\"seldon-deployment-example\")" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "## Load test" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "Start a load test which will post REST requests at 10 requests per second." + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "!helm install seldon-core-loadtesting --name loadtest \\\n", + " --set locust.host=http://seldon-core-seldon-apiserver:8080 \\\n", + " --set oauth.key=oauth-key \\\n", + " --set oauth.secret=oauth-secret \\\n", + " --namespace seldon \\\n", + " --repo https://storage.googleapis.com/seldon-charts" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "You should port-foward the grafana dashboard\n", + "\n", + "```bash\n", + "kubectl port-forward $(kubectl get pods -n seldon -l app=grafana-prom-server -o jsonpath='{.items[0].metadata.name}') -n seldon 3000:3000\n", + "```\n", + "\n", + "You can then iew an analytics dashboard inside the cluster at http://localhost:3000/dashboard/db/prediction-analytics?refresh=5s&orgId=1. Your IP address may be different. get it via minikube ip. Login with:\n", + " - Username : admin\n", + " - password : password (as set when starting seldon-core-analytics above)\n", + " \n", + " The dashboard should look like below:\n", + " \n", + " \n", + " \"predictor" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# Tear down" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "!helm delete loadtest --purge" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "!kubectl delete -f resources/model_with_canary.json -n seldon" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "!helm delete seldon-core-analytics --purge" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "!helm delete seldon-core --purge" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "!helm delete seldon-core-crd --purge" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [] + } + ], + "metadata": { + "anaconda-cloud": {}, + "kernelspec": { + "display_name": "Python 3", + "language": "python", + "name": "python3" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.6.4" + } + }, + "nbformat": 4, + "nbformat_minor": 1 +} diff --git a/notebooks/kubectl_demo_azure.ipynb b/notebooks/kubectl_demo_azure.ipynb index ead4974fa1..a00ee4cce6 100644 --- a/notebooks/kubectl_demo_azure.ipynb +++ b/notebooks/kubectl_demo_azure.ipynb @@ -71,7 +71,7 @@ "source": [ "!helm install ../helm-charts/seldon-core --name seldon-core \\\n", " --set rbac.enabled=false \\\n", - " --set apife_service_type=LoadBalancer \\\n", + " --set apife.service_type=LoadBalancer \\\n", " --namespace seldon" ] }, @@ -95,15 +95,13 @@ "metadata": {}, "outputs": [], "source": [ - "!kubectl get svc -n seldon seldon-apiserver" + "!kubectl get svc -n seldon -l app=seldon-apiserver-container-app" ] }, { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [ "!cp ../proto/prediction.proto ./proto\n", @@ -120,9 +118,7 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [ "import requests\n", @@ -136,7 +132,7 @@ " from subprocess import getoutput # python 3\n", "\n", "NAMESPACE=\"seldon\"\n", - "SELDON_API_IP=getoutput(\"kubectl get svc -n \"+NAMESPACE+\" seldon-apiserver -o jsonpath='{.status.loadBalancer.ingress[0].ip}'\")\n", + "SELDON_API_IP=getoutput(\"kubectl get svc -n \"+NAMESPACE+\" -l app=seldon-apiserver-container-app -o jsonpath='{.items[0].status.loadBalancer.ingress[0].ip}'\")\n", "\n", "def get_token():\n", " payload = {'grant_type': 'client_credentials'}\n", @@ -209,9 +205,7 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [ "!kubectl describe seldondeployments seldon-deployment-example -n seldon" @@ -243,9 +237,7 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [ "# REST Request\n", @@ -255,9 +247,7 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [ "# GRPC Request\n", @@ -299,9 +289,7 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [ "rest_request()" @@ -310,9 +298,7 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [ "grpc_request()" @@ -355,30 +341,28 @@ { "cell_type": "code", "execution_count": null, - "metadata": { - "collapsed": true - }, + "metadata": {}, "outputs": [], "source": [] } ], "metadata": { "kernelspec": { - "display_name": "Python 2", + "display_name": "Python 3", "language": "python", - "name": "python2" + "name": "python3" }, "language_info": { "codemirror_mode": { "name": "ipython", - "version": 2 + "version": 3 }, "file_extension": ".py", "mimetype": "text/x-python", "name": "python", "nbconvert_exporter": "python", - "pygments_lexer": "ipython2", - "version": "2.7.13" + "pygments_lexer": "ipython3", + "version": "3.6.4" } }, "nbformat": 4, diff --git a/notebooks/kubectl_demo_gcp.ipynb b/notebooks/kubectl_demo_gcp.ipynb index 4fac1df277..3414688cd9 100644 --- a/notebooks/kubectl_demo_gcp.ipynb +++ b/notebooks/kubectl_demo_gcp.ipynb @@ -72,7 +72,7 @@ "outputs": [], "source": [ "!helm install ../helm-charts/seldon-core --name seldon-core \\\n", - " --set apife_service_type=LoadBalancer \\\n", + " --set apife.service_type=LoadBalancer \\\n", " --namespace seldon" ] }, @@ -96,7 +96,7 @@ "metadata": {}, "outputs": [], "source": [ - "!kubectl get svc -n seldon seldon-apiserver" + "!kubectl get svc -n seldon -l app=seldon-apiserver-container-app" ] }, { @@ -133,7 +133,7 @@ " from subprocess import getoutput # python 3\n", "\n", "NAMESPACE=\"seldon\"\n", - "SELDON_API_IP=getoutput(\"kubectl get svc -n \"+NAMESPACE+\" seldon-apiserver -o jsonpath='{.status.loadBalancer.ingress[0].ip}'\")\n", + "SELDON_API_IP=getoutput(\"kubectl get svc -n \"+NAMESPACE+\" -l app=seldon-apiserver-container-app -o jsonpath='{.items[0].status.loadBalancer.ingress[0].ip}'\")\n", "\n", "def get_token():\n", " payload = {'grant_type': 'client_credentials'}\n", diff --git a/notebooks/kubectl_demo_minikube_rbac.ipynb b/notebooks/kubectl_demo_minikube_rbac.ipynb index b36c72e96b..0f4678b79e 100644 --- a/notebooks/kubectl_demo_minikube_rbac.ipynb +++ b/notebooks/kubectl_demo_minikube_rbac.ipynb @@ -510,6 +510,7 @@ "outputs": [], "source": [ "!helm install seldon-core-loadtesting --name loadtest \\\n", + " --set locust.host=http://seldon-core-seldon-apiserver:8080 \\\n", " --set oauth.key=oauth-key \\\n", " --set oauth.secret=oauth-secret \\\n", " --namespace seldon \\\n", diff --git a/readme.md b/readme.md index 20fa1bd938..7003f20fb6 100644 --- a/readme.md +++ b/readme.md @@ -62,7 +62,8 @@ Read the [overview to using seldon-core](./docs/getting_started/readme.md). - Jupyter notebooks showing worked examples: * Minikube: - * [Jupyter Notebook showing deployment of prebuilt model using Minikube - with RBAC](https://github.com/SeldonIO/seldon-core/blob/master/notebooks/kubectl_demo_minikube_rbac.ipynb) + * [Jupyter Notebook showing deployment of prebuilt model using Minikube and Helm](https://github.com/SeldonIO/seldon-core/blob/master/notebooks/kubectl_demo_minikube_rbac.ipynb) + * [Jupyter Notebook showing deployment of prebuilt model using Minikube, Helm and Ambassador reverse proxy](https://github.com/SeldonIO/seldon-core/blob/master/notebooks/helm_minikube_ambassador.ipynb) * [Jupyter notebook to create seldon-core with ksonnet and expose APIs using Ambassador on Minikube with RBAC.](https://github.com/SeldonIO/seldon-core/blob/master/notebooks/ksonnet_ambassador_minikube.ipynb) * GCP: * [Jupyter Notebook showing deployment of prebuilt model using GCP cluster](https://github.com/SeldonIO/seldon-core/blob/master/notebooks/kubectl_demo_gcp.ipynb) diff --git a/release.py b/release.py index 5512b8e19c..0088158960 100644 --- a/release.py +++ b/release.py @@ -90,9 +90,9 @@ def update_values_yaml_file(fpath, seldon_core_version, debug=False): f.close() d = yaml_to_dict(yaml_data) - d['apife']['image']['tag'] = seldon_core_version - d['cluster_manager']['image']['tag'] = seldon_core_version - d['engine']['image']['tag'] = seldon_core_version + d['apife']['image']['name'] = d['apife']['image']['name'].split(":")[0] + ":" + seldon_core_version + d['cluster_manager']['image']['name'] = d['cluster_manager']['image']['name'].split(":")[0] + ":" + seldon_core_version + d['engine']['image']['name'] = d['engine']['image']['name'].split(":")[0] + ":" + seldon_core_version with open(fpath, 'w') as f: f.write(dict_to_yaml(d)) diff --git a/seldon-core/seldon-core/prototypes/core.jsonnet b/seldon-core/seldon-core/prototypes/core.jsonnet index c14e0c2343..a29e8641f5 100644 --- a/seldon-core/seldon-core/prototypes/core.jsonnet +++ b/seldon-core/seldon-core/prototypes/core.jsonnet @@ -6,12 +6,12 @@ // @optionalParam namespace string default Namespace // @optionalParam withRbac string false Whether to include RBAC setup // @optionalParam withApife string true Whether to include builtin API Oauth fornt end server for ingress -// @optionalParam apifeImage string seldonio/apife:0.2.1-SNAPSHOT Default image for API Front End +// @optionalParam apifeImage string seldonio/apife:0.2.1-SNAPSHOT-CRD Default image for API Front End // @optionalParam apifeServiceType string NodePort API Front End Service Type -// @optionalParam operatorImage string seldonio/cluster-manager:0.2.1-SNAPSHOT Seldon cluster manager image version +// @optionalParam operatorImage string seldonio/cluster-manager:0.2.1-SNAPSHOT-CRD Seldon cluster manager image version // @optionalParam operatorSpringOpts string null cluster manager spring opts // @optionalParam operatorJavaOpts string null cluster manager java opts -// @optionalParam engineImage string seldonio/engine:0.2.1-SNAPSHOT Seldon engine image version +// @optionalParam engineImage string seldonio/engine:0.2.1-SNAPSHOT-CRD Seldon engine image version // TODO(https://github.com/ksonnet/ksonnet/issues/222): We have to add namespace as an explicit parameter // because ksonnet doesn't support inheriting it from the environment yet.