2016-09-30 02:33:23 -07:00
/ *
2018-07-03 00:37:22 -07:00
Copyright The Kubernetes Authors.
2016-09-30 02:33:23 -07:00
Licensed under the Apache License , Version 2.0 ( the "License" ) ;
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http : //www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing , software
distributed under the License is distributed on an "AS IS" BASIS ,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND , either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
* /
// This file was autogenerated by go-to-protobuf. Do not edit it manually!
syntax = 'proto2' ;
2018-07-03 00:37:22 -07:00
package k8s . io.api.extensions.v1beta1 ;
2016-09-30 02:33:23 -07:00
2018-07-03 00:37:22 -07:00
import "k8s.io/api/core/v1/generated.proto" ;
2017-05-11 01:29:10 -07:00
import "k8s.io/apimachinery/pkg/apis/meta/v1/generated.proto" ;
import "k8s.io/apimachinery/pkg/runtime/generated.proto" ;
import "k8s.io/apimachinery/pkg/runtime/schema/generated.proto" ;
import "k8s.io/apimachinery/pkg/util/intstr/generated.proto" ;
2016-09-30 02:33:23 -07:00
// Package-wide variables from generator "generated".
option go_package = "v1beta1" ;
2019-04-18 13:59:29 -07:00
// AllowedCSIDriver represents a single inline CSI Driver that is allowed to be used.
message AllowedCSIDriver {
// Name is the registered name of the CSI driver
optional string name = 1 ;
}
2018-07-03 00:37:22 -07:00
// AllowedFlexVolume represents a single Flexvolume that is allowed to be used.
// Deprecated: use AllowedFlexVolume from policy API Group instead.
message AllowedFlexVolume {
// driver is the name of the Flexvolume driver.
optional string driver = 1 ;
}
// AllowedHostPath defines the host volume conditions that will be enabled by a policy
// for pods to use. It requires the path prefix to be defined.
// Deprecated: use AllowedHostPath from policy API Group instead.
message AllowedHostPath {
// pathPrefix is the path prefix that the host volume must match.
// It does not support `*`.
// Trailing slashes are trimmed when validating the path prefix with a host path.
2018-12-03 19:19:44 -08:00
//
2018-07-03 00:37:22 -07:00
// Examples:
// `/foo` would allow `/foo`, `/foo/` and `/foo/bar`
// `/foo` would not allow `/food` or `/etc/foo`
optional string pathPrefix = 1 ;
// when set to true, will allow host volumes matching the pathPrefix only if all volume mounts are readOnly.
// +optional
optional bool readOnly = 2 ;
2016-09-30 02:33:23 -07:00
}
2018-07-03 00:37:22 -07:00
// DEPRECATED - This group version of DaemonSet is deprecated by apps/v1beta2/DaemonSet. See the release notes for
// more information.
2016-09-30 02:33:23 -07:00
// DaemonSet represents the configuration of a daemon set.
message DaemonSet {
// Standard object's metadata.
2019-04-18 13:59:29 -07:00
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
2017-05-11 01:29:10 -07:00
// +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1 ;
2016-09-30 02:33:23 -07:00
2017-05-11 01:29:10 -07:00
// The desired behavior of this daemon set.
2019-04-18 13:59:29 -07:00
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
optional DaemonSetSpec spec = 2 ;
2017-05-11 01:29:10 -07:00
// The current status of this daemon set. This data may be
2016-09-30 02:33:23 -07:00
// out of date by some window of time.
// Populated by the system.
// Read-only.
2019-04-18 13:59:29 -07:00
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
optional DaemonSetStatus status = 3 ;
}
2018-07-03 00:37:22 -07:00
// DaemonSetCondition describes the state of a DaemonSet at a certain point.
message DaemonSetCondition {
// Type of DaemonSet condition.
optional string type = 1 ;
// Status of the condition, one of True, False, Unknown.
optional string status = 2 ;
// Last time the condition transitioned from one status to another.
// +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.Time lastTransitionTime = 3 ;
// The reason for the condition's last transition.
// +optional
optional string reason = 4 ;
// A human readable message indicating details about the transition.
// +optional
optional string message = 5 ;
}
2016-09-30 02:33:23 -07:00
// DaemonSetList is a collection of daemon sets.
message DaemonSetList {
// Standard list metadata.
2019-04-18 13:59:29 -07:00
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
2017-05-11 01:29:10 -07:00
// +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1 ;
2016-09-30 02:33:23 -07:00
2017-05-11 01:29:10 -07:00
// A list of daemon sets.
2016-09-30 02:33:23 -07:00
repeated DaemonSet items = 2 ;
}
// DaemonSetSpec is the specification of a daemon set.
message DaemonSetSpec {
2017-05-11 01:29:10 -07:00
// A label query over pods that are managed by the daemon set.
2016-09-30 02:33:23 -07:00
// Must match in order to be controlled.
// If empty, defaulted to labels on Pod template.
2018-07-03 00:37:22 -07:00
// More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
2017-05-11 01:29:10 -07:00
// +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector selector = 1 ;
2016-09-30 02:33:23 -07:00
2017-05-11 01:29:10 -07:00
// An object that describes the pod that will be created.
2016-09-30 02:33:23 -07:00
// The DaemonSet will create exactly one copy of this pod on every node
// that matches the template's node selector (or on every node if no node
// selector is specified).
2018-07-03 00:37:22 -07:00
// More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template
optional k8s.io.api.core.v1.PodTemplateSpec template = 2 ;
2017-05-11 01:29:10 -07:00
// An update strategy to replace existing DaemonSet pods with new pods.
// +optional
optional DaemonSetUpdateStrategy updateStrategy = 3 ;
// The minimum number of seconds for which a newly created DaemonSet pod should
// be ready without any of its container crashing, for it to be considered
// available. Defaults to 0 (pod will be considered available as soon as it
// is ready).
// +optional
optional int32 minReadySeconds = 4 ;
2018-07-03 00:37:22 -07:00
// DEPRECATED.
2017-05-11 01:29:10 -07:00
// A sequence number representing a specific generation of the template.
// Populated by the system. It can be set only during the creation.
// +optional
optional int64 templateGeneration = 5 ;
2018-07-03 00:37:22 -07:00
// The number of old history to retain to allow rollback.
// This is a pointer to distinguish between explicit zero and not specified.
// Defaults to 10.
// +optional
optional int32 revisionHistoryLimit = 6 ;
2016-09-30 02:33:23 -07:00
}
// DaemonSetStatus represents the current status of a daemon set.
message DaemonSetStatus {
2017-05-11 01:29:10 -07:00
// The number of nodes that are running at least 1
2016-09-30 02:33:23 -07:00
// daemon pod and are supposed to run the daemon pod.
2018-07-03 00:37:22 -07:00
// More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/
2016-09-30 02:33:23 -07:00
optional int32 currentNumberScheduled = 1 ;
2017-05-11 01:29:10 -07:00
// The number of nodes that are running the daemon pod, but are
2016-09-30 02:33:23 -07:00
// not supposed to run the daemon pod.
2018-07-03 00:37:22 -07:00
// More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/
2016-09-30 02:33:23 -07:00
optional int32 numberMisscheduled = 2 ;
2017-05-11 01:29:10 -07:00
// The total number of nodes that should be running the daemon
2016-09-30 02:33:23 -07:00
// pod (including nodes correctly running the daemon pod).
2018-07-03 00:37:22 -07:00
// More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/
2016-09-30 02:33:23 -07:00
optional int32 desiredNumberScheduled = 3 ;
2017-05-11 01:29:10 -07:00
// The number of nodes that should be running the daemon pod and have one
// or more of the daemon pod running and ready.
optional int32 numberReady = 4 ;
// The most recent generation observed by the daemon set controller.
// +optional
optional int64 observedGeneration = 5 ;
// The total number of nodes that are running updated daemon pod
// +optional
optional int32 updatedNumberScheduled = 6 ;
// The number of nodes that should be running the
// daemon pod and have one or more of the daemon pod running and
// available (ready for at least spec.minReadySeconds)
// +optional
optional int32 numberAvailable = 7 ;
// The number of nodes that should be running the
// daemon pod and have none of the daemon pod running and available
// (ready for at least spec.minReadySeconds)
// +optional
optional int32 numberUnavailable = 8 ;
2018-07-03 00:37:22 -07:00
// Count of hash collisions for the DaemonSet. The DaemonSet controller
// uses this field as a collision avoidance mechanism when it needs to
// create the name for the newest ControllerRevision.
// +optional
optional int32 collisionCount = 9 ;
// Represents the latest available observations of a DaemonSet's current state.
// +optional
// +patchMergeKey=type
// +patchStrategy=merge
repeated DaemonSetCondition conditions = 10 ;
2017-05-11 01:29:10 -07:00
}
message DaemonSetUpdateStrategy {
// Type of daemon set update. Can be "RollingUpdate" or "OnDelete".
// Default is OnDelete.
// +optional
optional string type = 1 ;
// Rolling update config params. Present only if type = "RollingUpdate".
// ---
// TODO: Update this to follow our convention for oneOf, whatever we decide it
2018-07-03 00:37:22 -07:00
// to be. Same as Deployment `strategy.rollingUpdate`.
2017-05-11 01:29:10 -07:00
// See https://github.com/kubernetes/kubernetes/issues/35345
// +optional
optional RollingUpdateDaemonSet rollingUpdate = 2 ;
2016-09-30 02:33:23 -07:00
}
2018-07-03 00:37:22 -07:00
// DEPRECATED - This group version of Deployment is deprecated by apps/v1beta2/Deployment. See the release notes for
// more information.
2016-09-30 02:33:23 -07:00
// Deployment enables declarative updates for Pods and ReplicaSets.
message Deployment {
// Standard object metadata.
2017-05-11 01:29:10 -07:00
// +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1 ;
2016-09-30 02:33:23 -07:00
// Specification of the desired behavior of the Deployment.
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
optional DeploymentSpec spec = 2 ;
// Most recently observed status of the Deployment.
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
optional DeploymentStatus status = 3 ;
}
2017-05-11 01:29:10 -07:00
// DeploymentCondition describes the state of a deployment at a certain point.
message DeploymentCondition {
// Type of deployment condition.
optional string type = 1 ;
// Status of the condition, one of True, False, Unknown.
optional string status = 2 ;
// The last time this condition was updated.
optional k8s.io.apimachinery.pkg.apis.meta.v1.Time lastUpdateTime = 6 ;
// Last time the condition transitioned from one status to another.
optional k8s.io.apimachinery.pkg.apis.meta.v1.Time lastTransitionTime = 7 ;
// The reason for the condition's last transition.
optional string reason = 4 ;
// A human readable message indicating details about the transition.
optional string message = 5 ;
}
2016-09-30 02:33:23 -07:00
// DeploymentList is a list of Deployments.
message DeploymentList {
// Standard list metadata.
2017-05-11 01:29:10 -07:00
// +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1 ;
2016-09-30 02:33:23 -07:00
// Items is the list of Deployments.
repeated Deployment items = 2 ;
}
2018-07-03 00:37:22 -07:00
// DEPRECATED.
2016-09-30 02:33:23 -07:00
// DeploymentRollback stores the information required to rollback a deployment.
message DeploymentRollback {
// Required: This must match the Name of a deployment.
optional string name = 1 ;
// The annotations to be updated to a deployment
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
map < string , string > updatedAnnotations = 2 ;
// The config of this deployment rollback.
optional RollbackConfig rollbackTo = 3 ;
}
// DeploymentSpec is the specification of the desired behavior of the Deployment.
message DeploymentSpec {
// Number of desired pods. This is a pointer to distinguish between explicit
// zero and not specified. Defaults to 1.
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
optional int32 replicas = 1 ;
// Label selector for pods. Existing ReplicaSets whose pods are
// selected by this will be the ones affected by this deployment.
2017-05-11 01:29:10 -07:00
// +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector selector = 2 ;
2016-09-30 02:33:23 -07:00
// Template describes the pods that will be created.
2018-07-03 00:37:22 -07:00
optional k8s.io.api.core.v1.PodTemplateSpec template = 3 ;
2016-09-30 02:33:23 -07:00
// The deployment strategy to use to replace existing pods with new ones.
2017-05-11 01:29:10 -07:00
// +optional
2018-07-03 00:37:22 -07:00
// +patchStrategy=retainKeys
2016-09-30 02:33:23 -07:00
optional DeploymentStrategy strategy = 4 ;
// Minimum number of seconds for which a newly created pod should be ready
// without any of its container crashing, for it to be considered available.
// Defaults to 0 (pod will be considered available as soon as it is ready)
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
optional int32 minReadySeconds = 5 ;
// The number of old ReplicaSets to retain to allow rollback.
// This is a pointer to distinguish between explicit zero and not specified.
2018-12-03 19:19:44 -08:00
// This is set to the max value of int32 (i.e. 2147483647) by default, which
// means "retaining all old RelicaSets".
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
optional int32 revisionHistoryLimit = 6 ;
// Indicates that the deployment is paused and will not be processed by the
// deployment controller.
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
optional bool paused = 7 ;
2018-07-03 00:37:22 -07:00
// DEPRECATED.
2016-09-30 02:33:23 -07:00
// The config this deployment is rolling back to. Will be cleared after rollback is done.
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
optional RollbackConfig rollbackTo = 8 ;
2017-05-11 01:29:10 -07:00
// The maximum time in seconds for a deployment to make progress before it
// is considered to be failed. The deployment controller will continue to
// process failed deployments and a condition with a ProgressDeadlineExceeded
2018-07-03 00:37:22 -07:00
// reason will be surfaced in the deployment status. Note that progress will
2018-11-28 21:13:03 -08:00
// not be estimated during the time a deployment is paused. This is set to
// the max value of int32 (i.e. 2147483647) by default, which means "no deadline".
2018-07-03 00:37:22 -07:00
// +optional
2017-05-11 01:29:10 -07:00
optional int32 progressDeadlineSeconds = 9 ;
2016-09-30 02:33:23 -07:00
}
// DeploymentStatus is the most recently observed status of the Deployment.
message DeploymentStatus {
// The generation observed by the deployment controller.
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
optional int64 observedGeneration = 1 ;
// Total number of non-terminated pods targeted by this deployment (their labels match the selector).
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
optional int32 replicas = 2 ;
// Total number of non-terminated pods targeted by this deployment that have the desired template spec.
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
optional int32 updatedReplicas = 3 ;
2017-05-11 01:29:10 -07:00
// Total number of ready pods targeted by this deployment.
// +optional
optional int32 readyReplicas = 7 ;
2016-09-30 02:33:23 -07:00
// Total number of available pods (ready for at least minReadySeconds) targeted by this deployment.
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
optional int32 availableReplicas = 4 ;
2018-07-03 00:37:22 -07:00
// Total number of unavailable pods targeted by this deployment. This is the total number of
// pods that are still required for the deployment to have 100% available capacity. They may
// either be pods that are running but not yet available or pods that still have not been created.
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
optional int32 unavailableReplicas = 5 ;
2017-05-11 01:29:10 -07:00
// Represents the latest available observations of a deployment's current state.
2018-07-03 00:37:22 -07:00
// +patchMergeKey=type
// +patchStrategy=merge
2017-05-11 01:29:10 -07:00
repeated DeploymentCondition conditions = 6 ;
2018-07-03 00:37:22 -07:00
// Count of hash collisions for the Deployment. The Deployment controller uses this
// field as a collision avoidance mechanism when it needs to create the name for the
// newest ReplicaSet.
// +optional
optional int32 collisionCount = 8 ;
2016-09-30 02:33:23 -07:00
}
// DeploymentStrategy describes how to replace existing pods with new ones.
message DeploymentStrategy {
// Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate.
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
optional string type = 1 ;
// Rolling update config params. Present only if DeploymentStrategyType =
// RollingUpdate.
// ---
// TODO: Update this to follow our convention for oneOf, whatever we decide it
// to be.
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
optional RollingUpdateDeployment rollingUpdate = 2 ;
}
// FSGroupStrategyOptions defines the strategy type and options used to create the strategy.
2018-07-03 00:37:22 -07:00
// Deprecated: use FSGroupStrategyOptions from policy API Group instead.
2016-09-30 02:33:23 -07:00
message FSGroupStrategyOptions {
2018-07-03 00:37:22 -07:00
// rule is the strategy that will dictate what FSGroup is used in the SecurityContext.
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
optional string rule = 1 ;
2018-07-03 00:37:22 -07:00
// ranges are the allowed ranges of fs groups. If you would like to force a single
// fs group then supply a single range with the same start and end. Required for MustRunAs.
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
repeated IDRange ranges = 2 ;
}
2020-04-06 09:23:02 -07:00
// HTTPIngressPath associates a path with a backend. Incoming urls matching the
// path are forwarded to the backend.
2016-09-30 02:33:23 -07:00
message HTTPIngressPath {
2020-04-06 09:23:02 -07:00
// Path is matched against the path of an incoming request. Currently it can
// contain characters disallowed from the conventional "path" part of a URL
// as defined by RFC 3986. Paths must begin with a '/'. When unspecified,
// all paths from incoming requests are matched.
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
optional string path = 1 ;
2020-04-06 09:23:02 -07:00
// PathType determines the interpretation of the Path matching. PathType can
// be one of the following values:
// * Exact: Matches the URL path exactly.
// * Prefix: Matches based on a URL path prefix split by '/'. Matching is
// done on a path element by element basis. A path element refers is the
// list of labels in the path split by the '/' separator. A request is a
// match for path p if every p is an element-wise prefix of p of the
// request path. Note that if the last element of the path is a substring
// of the last element in request path, it is not a match (e.g. /foo/bar
// matches /foo/bar/baz, but does not match /foo/barbaz).
// * ImplementationSpecific: Interpretation of the Path matching is up to
// the IngressClass. Implementations can treat this as a separate PathType
// or treat it identically to Prefix or Exact path types.
// Implementations are required to support all path types.
// Defaults to ImplementationSpecific.
optional string pathType = 3 ;
2016-09-30 02:33:23 -07:00
// Backend defines the referenced service endpoint to which the traffic
// will be forwarded to.
optional IngressBackend backend = 2 ;
}
// HTTPIngressRuleValue is a list of http selectors pointing to backends.
// In the example: http://<host>/<path>?<searchpart> -> backend where
// where parts of the url correspond to RFC 3986, this resource will be used
// to match against everything after the last '/' and before the first '?'
// or '#'.
message HTTPIngressRuleValue {
// A collection of paths that map requests to backends.
repeated HTTPIngressPath paths = 1 ;
}
2018-07-03 00:37:22 -07:00
// HostPortRange defines a range of host ports that will be enabled by a policy
2016-09-30 02:33:23 -07:00
// for pods to use. It requires both the start and end to be defined.
2018-07-03 00:37:22 -07:00
// Deprecated: use HostPortRange from policy API Group instead.
2016-09-30 02:33:23 -07:00
message HostPortRange {
// min is the start of the range, inclusive.
optional int32 min = 1 ;
// max is the end of the range, inclusive.
optional int32 max = 2 ;
}
2018-07-03 00:37:22 -07:00
// IDRange provides a min/max of an allowed range of IDs.
// Deprecated: use IDRange from policy API Group instead.
2016-09-30 02:33:23 -07:00
message IDRange {
2018-07-03 00:37:22 -07:00
// min is the start of the range, inclusive.
2016-09-30 02:33:23 -07:00
optional int64 min = 1 ;
2018-07-03 00:37:22 -07:00
// max is the end of the range, inclusive.
2016-09-30 02:33:23 -07:00
optional int64 max = 2 ;
}
2018-07-03 00:37:22 -07:00
// DEPRECATED 1.9 - This group version of IPBlock is deprecated by networking/v1/IPBlock.
2020-04-06 09:23:02 -07:00
// IPBlock describes a particular CIDR (Ex. "192.168.1.1/24","2001:db9::/64") that is allowed
// to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs
// that should not be included within this rule.
2018-07-03 00:37:22 -07:00
message IPBlock {
// CIDR is a string representing the IP Block
2020-04-06 09:23:02 -07:00
// Valid examples are "192.168.1.1/24" or "2001:db9::/64"
2018-07-03 00:37:22 -07:00
optional string cidr = 1 ;
// Except is a slice of CIDRs that should not be included within an IP Block
2020-04-06 09:23:02 -07:00
// Valid examples are "192.168.1.1/24" or "2001:db9::/64"
2018-07-03 00:37:22 -07:00
// Except values will be rejected if they are outside the CIDR range
// +optional
repeated string except = 2 ;
}
2016-09-30 02:33:23 -07:00
// Ingress is a collection of rules that allow inbound connections to reach the
// endpoints defined by a backend. An Ingress can be configured to give services
// externally-reachable urls, load balance traffic, terminate SSL, offer name
// based virtual hosting etc.
2019-04-18 13:59:29 -07:00
// DEPRECATED - This group version of Ingress is deprecated by networking.k8s.io/v1beta1 Ingress. See the release notes for more information.
2016-09-30 02:33:23 -07:00
message Ingress {
// Standard object's metadata.
2019-04-18 13:59:29 -07:00
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
2017-05-11 01:29:10 -07:00
// +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1 ;
2016-09-30 02:33:23 -07:00
// Spec is the desired state of the Ingress.
2019-04-18 13:59:29 -07:00
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
optional IngressSpec spec = 2 ;
// Status is the current state of the Ingress.
2019-04-18 13:59:29 -07:00
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
optional IngressStatus status = 3 ;
}
// IngressBackend describes all endpoints for a given service and port.
message IngressBackend {
// Specifies the name of the referenced service.
2020-04-06 09:23:02 -07:00
// +optional
2016-09-30 02:33:23 -07:00
optional string serviceName = 1 ;
// Specifies the port of the referenced service.
2020-04-06 09:23:02 -07:00
// +optional
2017-05-11 01:29:10 -07:00
optional k8s.io.apimachinery.pkg.util.intstr.IntOrString servicePort = 2 ;
2020-04-06 09:23:02 -07:00
// Resource is an ObjectRef to another Kubernetes resource in the namespace
// of the Ingress object. If resource is specified, serviceName and servicePort
// must not be specified.
// +optional
optional k8s.io.api.core.v1.TypedLocalObjectReference resource = 3 ;
2016-09-30 02:33:23 -07:00
}
// IngressList is a collection of Ingress.
message IngressList {
// Standard object's metadata.
2019-04-18 13:59:29 -07:00
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
2017-05-11 01:29:10 -07:00
// +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1 ;
2016-09-30 02:33:23 -07:00
// Items is the list of Ingress.
repeated Ingress items = 2 ;
}
// IngressRule represents the rules mapping the paths under a specified host to
// the related backend services. Incoming requests are first evaluated for a host
// match, then routed to the backend associated with the matching IngressRuleValue.
message IngressRule {
2020-04-06 09:23:02 -07:00
// Host is the fully qualified domain name of a network host, as defined by RFC 3986.
// Note the following deviations from the "host" part of the
// URI as defined in RFC 3986:
// 1. IPs are not allowed. Currently an IngressRuleValue can only apply to
// the IP in the Spec of the parent Ingress.
2016-09-30 02:33:23 -07:00
// 2. The `:` delimiter is not respected because ports are not allowed.
// Currently the port of an Ingress is implicitly :80 for http and
// :443 for https.
// Both these may change in the future.
2020-04-06 09:23:02 -07:00
// Incoming requests are matched against the host before the
// IngressRuleValue. If the host is unspecified, the Ingress routes all
// traffic based on the specified IngressRuleValue.
//
// Host can be "precise" which is a domain name without the terminating dot of
// a network host (e.g. "foo.bar.com") or "wildcard", which is a domain name
// prefixed with a single wildcard label (e.g. "*.foo.com").
// The wildcard character '*' must appear by itself as the first DNS label and
// matches only a single label. You cannot have a wildcard label by itself (e.g. Host == "*").
// Requests will be matched against the Host field in the following way:
// 1. If Host is precise, the request matches this rule if the http host header is equal to Host.
// 2. If Host is a wildcard, then the request matches this rule if the http host header
// is to equal to the suffix (removing the first label) of the wildcard rule.
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
optional string host = 1 ;
// IngressRuleValue represents a rule to route requests for this IngressRule.
// If unspecified, the rule defaults to a http catch-all. Whether that sends
// just traffic matching the host to the default backend or all traffic to the
// default backend, is left to the controller fulfilling the Ingress. Http is
// currently the only supported IngressRuleValue.
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
optional IngressRuleValue ingressRuleValue = 2 ;
}
// IngressRuleValue represents a rule to apply against incoming requests. If the
// rule is satisfied, the request is routed to the specified backend. Currently
// mixing different types of rules in a single Ingress is disallowed, so exactly
// one of the following must be set.
message IngressRuleValue {
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
optional HTTPIngressRuleValue http = 1 ;
}
// IngressSpec describes the Ingress the user wishes to exist.
message IngressSpec {
2020-04-06 09:23:02 -07:00
// IngressClassName is the name of the IngressClass cluster resource. The
// associated IngressClass defines which controller will implement the
// resource. This replaces the deprecated `kubernetes.io/ingress.class`
// annotation. For backwards compatibility, when that annotation is set, it
// must be given precedence over this field. The controller may emit a
// warning if the field and annotation have different values.
// Implementations of this API should ignore Ingresses without a class
// specified. An IngressClass resource may be marked as default, which can
// be used to set a default value for this field. For more information,
// refer to the IngressClass documentation.
// +optional
optional string ingressClassName = 4 ;
2016-09-30 02:33:23 -07:00
// A default backend capable of servicing requests that don't match any
// rule. At least one of 'backend' or 'rules' must be specified. This field
// is optional to allow the loadbalancer controller or defaulting logic to
// specify a global default.
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
optional IngressBackend backend = 1 ;
// TLS configuration. Currently the Ingress only supports a single TLS
// port, 443. If multiple members of this list specify different hosts, they
// will be multiplexed on the same port according to the hostname specified
// through the SNI TLS extension, if the ingress controller fulfilling the
// ingress supports SNI.
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
repeated IngressTLS tls = 2 ;
// A list of host rules used to configure the Ingress. If unspecified, or
// no rule matches, all traffic is sent to the default backend.
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
repeated IngressRule rules = 3 ;
}
// IngressStatus describe the current state of the Ingress.
message IngressStatus {
// LoadBalancer contains the current status of the load-balancer.
2017-05-11 01:29:10 -07:00
// +optional
2018-07-03 00:37:22 -07:00
optional k8s.io.api.core.v1.LoadBalancerStatus loadBalancer = 1 ;
2016-09-30 02:33:23 -07:00
}
// IngressTLS describes the transport layer security associated with an Ingress.
message IngressTLS {
// Hosts are a list of hosts included in the TLS certificate. The values in
// this list must match the name/s used in the tlsSecret. Defaults to the
// wildcard host setting for the loadbalancer controller fulfilling this
// Ingress, if left unspecified.
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
repeated string hosts = 1 ;
// SecretName is the name of the secret used to terminate SSL traffic on 443.
// Field is left optional to allow SSL routing based on SNI hostname alone.
// If the SNI host in a listener conflicts with the "Host" header field used
// by an IngressRule, the SNI host is used for termination and value of the
// Host header is used for routing.
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
optional string secretName = 2 ;
}
2018-07-03 00:37:22 -07:00
// DEPRECATED 1.9 - This group version of NetworkPolicy is deprecated by networking/v1/NetworkPolicy.
// NetworkPolicy describes what network traffic is allowed for a set of Pods
2016-09-30 02:33:23 -07:00
message NetworkPolicy {
// Standard object's metadata.
2019-04-18 13:59:29 -07:00
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
2017-05-11 01:29:10 -07:00
// +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1 ;
2016-09-30 02:33:23 -07:00
// Specification of the desired behavior for this NetworkPolicy.
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
optional NetworkPolicySpec spec = 2 ;
}
2018-07-03 00:37:22 -07:00
// DEPRECATED 1.9 - This group version of NetworkPolicyEgressRule is deprecated by networking/v1/NetworkPolicyEgressRule.
// NetworkPolicyEgressRule describes a particular set of traffic that is allowed out of pods
// matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and to.
// This type is beta-level in 1.8
message NetworkPolicyEgressRule {
// List of destination ports for outgoing traffic.
// Each item in this list is combined using a logical OR. If this field is
// empty or missing, this rule matches all ports (traffic not restricted by port).
// If this field is present and contains at least one item, then this rule allows
// traffic only if the traffic matches at least one port in the list.
// +optional
repeated NetworkPolicyPort ports = 1 ;
// List of destinations for outgoing traffic of pods selected for this rule.
// Items in this list are combined using a logical OR operation. If this field is
// empty or missing, this rule matches all destinations (traffic not restricted by
// destination). If this field is present and contains at least one item, this rule
// allows traffic only if the traffic matches at least one item in the to list.
// +optional
repeated NetworkPolicyPeer to = 2 ;
}
// DEPRECATED 1.9 - This group version of NetworkPolicyIngressRule is deprecated by networking/v1/NetworkPolicyIngressRule.
2016-09-30 02:33:23 -07:00
// This NetworkPolicyIngressRule matches traffic if and only if the traffic matches both ports AND from.
message NetworkPolicyIngressRule {
// List of ports which should be made accessible on the pods selected for this rule.
// Each item in this list is combined using a logical OR.
2018-07-03 00:37:22 -07:00
// If this field is empty or missing, this rule matches all ports (traffic not restricted by port).
2016-09-30 02:33:23 -07:00
// If this field is present and contains at least one item, then this rule allows traffic
// only if the traffic matches at least one port in the list.
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
repeated NetworkPolicyPort ports = 1 ;
// List of sources which should be able to access the pods selected for this rule.
// Items in this list are combined using a logical OR operation.
2018-07-03 00:37:22 -07:00
// If this field is empty or missing, this rule matches all sources (traffic not restricted by source).
2019-08-14 02:00:39 -07:00
// If this field is present and contains at least one item, this rule allows traffic only if the
2016-09-30 02:33:23 -07:00
// traffic matches at least one item in the from list.
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
repeated NetworkPolicyPeer from = 2 ;
}
2018-07-03 00:37:22 -07:00
// DEPRECATED 1.9 - This group version of NetworkPolicyList is deprecated by networking/v1/NetworkPolicyList.
2016-09-30 02:33:23 -07:00
// Network Policy List is a list of NetworkPolicy objects.
message NetworkPolicyList {
// Standard list metadata.
2019-04-18 13:59:29 -07:00
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
2017-05-11 01:29:10 -07:00
// +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1 ;
2016-09-30 02:33:23 -07:00
// Items is a list of schema objects.
repeated NetworkPolicy items = 2 ;
}
2018-07-03 00:37:22 -07:00
// DEPRECATED 1.9 - This group version of NetworkPolicyPeer is deprecated by networking/v1/NetworkPolicyPeer.
2016-09-30 02:33:23 -07:00
message NetworkPolicyPeer {
2018-07-03 00:37:22 -07:00
// This is a label selector which selects Pods. This field follows standard label
// selector semantics; if present but empty, it selects all pods.
2018-12-03 19:19:44 -08:00
//
2018-07-03 00:37:22 -07:00
// If NamespaceSelector is also set, then the NetworkPolicyPeer as a whole selects
// the Pods matching PodSelector in the Namespaces selected by NamespaceSelector.
// Otherwise it selects the Pods matching PodSelector in the policy's own Namespace.
2017-05-11 01:29:10 -07:00
// +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector podSelector = 1 ;
2016-09-30 02:33:23 -07:00
2018-07-03 00:37:22 -07:00
// Selects Namespaces using cluster-scoped labels. This field follows standard label
// selector semantics; if present but empty, it selects all namespaces.
2018-12-03 19:19:44 -08:00
//
2018-07-03 00:37:22 -07:00
// If PodSelector is also set, then the NetworkPolicyPeer as a whole selects
// the Pods matching PodSelector in the Namespaces selected by NamespaceSelector.
// Otherwise it selects all Pods in the Namespaces selected by NamespaceSelector.
2017-05-11 01:29:10 -07:00
// +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector namespaceSelector = 2 ;
2018-07-03 00:37:22 -07:00
// IPBlock defines policy on a particular IPBlock. If this field is set then
// neither of the other fields can be.
// +optional
optional IPBlock ipBlock = 3 ;
2016-09-30 02:33:23 -07:00
}
2018-07-03 00:37:22 -07:00
// DEPRECATED 1.9 - This group version of NetworkPolicyPort is deprecated by networking/v1/NetworkPolicyPort.
2016-09-30 02:33:23 -07:00
message NetworkPolicyPort {
2018-11-28 21:13:03 -08:00
// Optional. The protocol (TCP, UDP, or SCTP) which traffic must match.
2016-09-30 02:33:23 -07:00
// If not specified, this field defaults to TCP.
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
optional string protocol = 1 ;
// If specified, the port on the given protocol. This can
// either be a numerical or named port on a pod. If this field is not provided,
// this matches all port names and numbers.
// If present, only traffic on the specified protocol AND port
// will be matched.
2017-05-11 01:29:10 -07:00
// +optional
optional k8s.io.apimachinery.pkg.util.intstr.IntOrString port = 2 ;
2016-09-30 02:33:23 -07:00
}
2018-07-03 00:37:22 -07:00
// DEPRECATED 1.9 - This group version of NetworkPolicySpec is deprecated by networking/v1/NetworkPolicySpec.
2016-09-30 02:33:23 -07:00
message NetworkPolicySpec {
// Selects the pods to which this NetworkPolicy object applies. The array of ingress rules
// is applied to any pods selected by this field. Multiple network policies can select the
// same set of pods. In this case, the ingress rules for each are combined additively.
// This field is NOT optional and follows standard label selector semantics.
// An empty podSelector matches all pods in this namespace.
2017-05-11 01:29:10 -07:00
optional k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector podSelector = 1 ;
2016-09-30 02:33:23 -07:00
// List of ingress rules to be applied to the selected pods.
2018-07-03 00:37:22 -07:00
// Traffic is allowed to a pod if there are no NetworkPolicies selecting the pod
2016-09-30 02:33:23 -07:00
// OR if the traffic source is the pod's local node,
// OR if the traffic matches at least one ingress rule across all of the NetworkPolicy
// objects whose podSelector matches the pod.
2018-07-03 00:37:22 -07:00
// If this field is empty then this NetworkPolicy does not allow any traffic
// (and serves solely to ensure that the pods it selects are isolated by default).
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
repeated NetworkPolicyIngressRule ingress = 2 ;
2018-07-03 00:37:22 -07:00
// List of egress rules to be applied to the selected pods. Outgoing traffic is
// allowed if there are no NetworkPolicies selecting the pod (and cluster policy
// otherwise allows the traffic), OR if the traffic matches at least one egress rule
// across all of the NetworkPolicy objects whose podSelector matches the pod. If
// this field is empty then this NetworkPolicy limits all outgoing traffic (and serves
// solely to ensure that the pods it selects are isolated by default).
// This field is beta-level in 1.8
// +optional
repeated NetworkPolicyEgressRule egress = 3 ;
// List of rule types that the NetworkPolicy relates to.
2019-04-18 13:59:29 -07:00
// Valid options are "Ingress", "Egress", or "Ingress,Egress".
2018-07-03 00:37:22 -07:00
// If this field is not specified, it will default based on the existence of Ingress or Egress rules;
// policies that contain an Egress section are assumed to affect Egress, and all policies
// (whether or not they contain an Ingress section) are assumed to affect Ingress.
// If you want to write an egress-only policy, you must explicitly specify policyTypes [ "Egress" ].
// Likewise, if you want to write a policy that specifies that no egress is allowed,
// you must specify a policyTypes value that include "Egress" (since such a policy would not include
// an Egress section and would otherwise default to just [ "Ingress" ]).
// This field is beta-level in 1.8
// +optional
repeated string policyTypes = 4 ;
2016-09-30 02:33:23 -07:00
}
2018-07-03 00:37:22 -07:00
// PodSecurityPolicy governs the ability to make requests that affect the Security Context
2016-09-30 02:33:23 -07:00
// that will be applied to a pod and container.
2018-07-03 00:37:22 -07:00
// Deprecated: use PodSecurityPolicy from policy API Group instead.
2016-09-30 02:33:23 -07:00
message PodSecurityPolicy {
// Standard object's metadata.
2019-04-18 13:59:29 -07:00
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
2017-05-11 01:29:10 -07:00
// +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1 ;
2016-09-30 02:33:23 -07:00
// spec defines the policy enforced.
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
optional PodSecurityPolicySpec spec = 2 ;
}
2018-07-03 00:37:22 -07:00
// PodSecurityPolicyList is a list of PodSecurityPolicy objects.
// Deprecated: use PodSecurityPolicyList from policy API Group instead.
2016-09-30 02:33:23 -07:00
message PodSecurityPolicyList {
// Standard list metadata.
2019-04-18 13:59:29 -07:00
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
2017-05-11 01:29:10 -07:00
// +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1 ;
2016-09-30 02:33:23 -07:00
2018-07-03 00:37:22 -07:00
// items is a list of schema objects.
2016-09-30 02:33:23 -07:00
repeated PodSecurityPolicy items = 2 ;
}
2018-07-03 00:37:22 -07:00
// PodSecurityPolicySpec defines the policy enforced.
// Deprecated: use PodSecurityPolicySpec from policy API Group instead.
2016-09-30 02:33:23 -07:00
message PodSecurityPolicySpec {
// privileged determines if a pod can request to be run as privileged.
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
optional bool privileged = 1 ;
2018-07-03 00:37:22 -07:00
// defaultAddCapabilities is the default set of capabilities that will be added to the container
// unless the pod spec specifically drops the capability. You may not list a capability in both
// defaultAddCapabilities and requiredDropCapabilities. Capabilities added here are implicitly
// allowed, and need not be included in the allowedCapabilities list.
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
repeated string defaultAddCapabilities = 2 ;
2018-07-03 00:37:22 -07:00
// requiredDropCapabilities are the capabilities that will be dropped from the container. These
2016-09-30 02:33:23 -07:00
// are required to be dropped and cannot be added.
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
repeated string requiredDropCapabilities = 3 ;
2018-07-03 00:37:22 -07:00
// allowedCapabilities is a list of capabilities that can be requested to add to the container.
2016-09-30 02:33:23 -07:00
// Capabilities in this field may be added at the pod author's discretion.
2018-07-03 00:37:22 -07:00
// You must not list a capability in both allowedCapabilities and requiredDropCapabilities.
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
repeated string allowedCapabilities = 4 ;
2018-07-03 00:37:22 -07:00
// volumes is a white list of allowed volume plugins. Empty indicates that
// no volumes may be used. To allow all volumes you may use '*'.
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
repeated string volumes = 5 ;
// hostNetwork determines if the policy allows the use of HostNetwork in the pod spec.
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
optional bool hostNetwork = 6 ;
// hostPorts determines which host port ranges are allowed to be exposed.
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
repeated HostPortRange hostPorts = 7 ;
// hostPID determines if the policy allows the use of HostPID in the pod spec.
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
optional bool hostPID = 8 ;
// hostIPC determines if the policy allows the use of HostIPC in the pod spec.
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
optional bool hostIPC = 9 ;
// seLinux is the strategy that will dictate the allowable labels that may be set.
optional SELinuxStrategyOptions seLinux = 10 ;
// runAsUser is the strategy that will dictate the allowable RunAsUser values that may be set.
optional RunAsUserStrategyOptions runAsUser = 11 ;
2018-12-03 19:19:44 -08:00
// RunAsGroup is the strategy that will dictate the allowable RunAsGroup values that may be set.
// If this field is omitted, the pod's RunAsGroup can take any value. This field requires the
// RunAsGroup feature gate to be enabled.
// +optional
optional RunAsGroupStrategyOptions runAsGroup = 22 ;
2018-07-03 00:37:22 -07:00
// supplementalGroups is the strategy that will dictate what supplemental groups are used by the SecurityContext.
2016-09-30 02:33:23 -07:00
optional SupplementalGroupsStrategyOptions supplementalGroups = 12 ;
2018-07-03 00:37:22 -07:00
// fsGroup is the strategy that will dictate what fs group is used by the SecurityContext.
2016-09-30 02:33:23 -07:00
optional FSGroupStrategyOptions fsGroup = 13 ;
2018-07-03 00:37:22 -07:00
// readOnlyRootFilesystem when set to true will force containers to run with a read only root file
2016-09-30 02:33:23 -07:00
// system. If the container specifically requests to run with a non-read only root file system
// the PSP should deny the pod.
// If set to false the container may run with a read only root file system if it wishes but it
// will not be forced to.
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
optional bool readOnlyRootFilesystem = 14 ;
2018-07-03 00:37:22 -07:00
// defaultAllowPrivilegeEscalation controls the default setting for whether a
// process can gain more privileges than its parent process.
// +optional
optional bool defaultAllowPrivilegeEscalation = 15 ;
// allowPrivilegeEscalation determines if a pod can request to allow
// privilege escalation. If unspecified, defaults to true.
// +optional
optional bool allowPrivilegeEscalation = 16 ;
// allowedHostPaths is a white list of allowed host paths. Empty indicates
// that all host paths may be used.
// +optional
repeated AllowedHostPath allowedHostPaths = 17 ;
// allowedFlexVolumes is a whitelist of allowed Flexvolumes. Empty or nil indicates that all
// Flexvolumes may be used. This parameter is effective only when the usage of the Flexvolumes
// is allowed in the "volumes" field.
// +optional
repeated AllowedFlexVolume allowedFlexVolumes = 18 ;
2019-04-18 13:59:29 -07:00
// AllowedCSIDrivers is a whitelist of inline CSI drivers that must be explicitly set to be embedded within a pod spec.
2019-07-18 13:39:06 -07:00
// An empty value indicates that any CSI driver can be used for inline ephemeral volumes.
2019-04-18 13:59:29 -07:00
// +optional
repeated AllowedCSIDriver allowedCSIDrivers = 23 ;
2018-07-03 00:37:22 -07:00
// allowedUnsafeSysctls is a list of explicitly allowed unsafe sysctls, defaults to none.
// Each entry is either a plain sysctl name or ends in "*" in which case it is considered
// as a prefix of allowed sysctls. Single * means all unsafe sysctls are allowed.
// Kubelet has to whitelist all allowed unsafe sysctls explicitly to avoid rejection.
2018-12-03 19:19:44 -08:00
//
2018-07-03 00:37:22 -07:00
// Examples:
// e.g. "foo/*" allows "foo/bar", "foo/baz", etc.
// e.g. "foo.*" allows "foo.bar", "foo.baz", etc.
// +optional
repeated string allowedUnsafeSysctls = 19 ;
// forbiddenSysctls is a list of explicitly forbidden sysctls, defaults to none.
// Each entry is either a plain sysctl name or ends in "*" in which case it is considered
// as a prefix of forbidden sysctls. Single * means all sysctls are forbidden.
2018-12-03 19:19:44 -08:00
//
2018-07-03 00:37:22 -07:00
// Examples:
// e.g. "foo/*" forbids "foo/bar", "foo/baz", etc.
// e.g. "foo.*" forbids "foo.bar", "foo.baz", etc.
// +optional
repeated string forbiddenSysctls = 20 ;
2018-11-28 21:13:03 -08:00
// AllowedProcMountTypes is a whitelist of allowed ProcMountTypes.
// Empty or nil indicates that only the DefaultProcMountType may be used.
// This requires the ProcMountType feature flag to be enabled.
// +optional
repeated string allowedProcMountTypes = 21 ;
2019-07-18 13:39:06 -07:00
// runtimeClass is the strategy that will dictate the allowable RuntimeClasses for a pod.
// If this field is omitted, the pod's runtimeClassName field is unrestricted.
// Enforcement of this field depends on the RuntimeClass feature gate being enabled.
// +optional
optional RuntimeClassStrategyOptions runtimeClass = 24 ;
2016-09-30 02:33:23 -07:00
}
2018-07-03 00:37:22 -07:00
// DEPRECATED - This group version of ReplicaSet is deprecated by apps/v1beta2/ReplicaSet. See the release notes for
// more information.
// ReplicaSet ensures that a specified number of pod replicas are running at any given time.
2016-09-30 02:33:23 -07:00
message ReplicaSet {
// If the Labels of a ReplicaSet are empty, they are defaulted to
// be the same as the Pod(s) that the ReplicaSet manages.
2019-04-18 13:59:29 -07:00
// Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
2017-05-11 01:29:10 -07:00
// +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1 ;
2016-09-30 02:33:23 -07:00
// Spec defines the specification of the desired behavior of the ReplicaSet.
2019-04-18 13:59:29 -07:00
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
optional ReplicaSetSpec spec = 2 ;
// Status is the most recently observed status of the ReplicaSet.
// This data may be out of date by some window of time.
// Populated by the system.
// Read-only.
2019-04-18 13:59:29 -07:00
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
optional ReplicaSetStatus status = 3 ;
}
2017-05-11 01:29:10 -07:00
// ReplicaSetCondition describes the state of a replica set at a certain point.
message ReplicaSetCondition {
// Type of replica set condition.
optional string type = 1 ;
// Status of the condition, one of True, False, Unknown.
optional string status = 2 ;
// The last time the condition transitioned from one status to another.
// +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.Time lastTransitionTime = 3 ;
// The reason for the condition's last transition.
// +optional
optional string reason = 4 ;
// A human readable message indicating details about the transition.
// +optional
optional string message = 5 ;
}
2016-09-30 02:33:23 -07:00
// ReplicaSetList is a collection of ReplicaSets.
message ReplicaSetList {
// Standard list metadata.
2019-04-18 13:59:29 -07:00
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
2017-05-11 01:29:10 -07:00
// +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1 ;
2016-09-30 02:33:23 -07:00
// List of ReplicaSets.
2018-07-03 00:37:22 -07:00
// More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller
2016-09-30 02:33:23 -07:00
repeated ReplicaSet items = 2 ;
}
// ReplicaSetSpec is the specification of a ReplicaSet.
message ReplicaSetSpec {
// Replicas is the number of desired replicas.
// This is a pointer to distinguish between explicit zero and unspecified.
// Defaults to 1.
2018-07-03 00:37:22 -07:00
// More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
optional int32 replicas = 1 ;
2017-05-11 01:29:10 -07:00
// Minimum number of seconds for which a newly created pod should be ready
// without any of its container crashing, for it to be considered available.
// Defaults to 0 (pod will be considered available as soon as it is ready)
// +optional
optional int32 minReadySeconds = 4 ;
2016-09-30 02:33:23 -07:00
// Selector is a label query over pods that should match the replica count.
// If the selector is empty, it is defaulted to the labels present on the pod template.
// Label keys and values that must match in order to be controlled by this replica set.
2018-07-03 00:37:22 -07:00
// More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
2017-05-11 01:29:10 -07:00
// +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector selector = 2 ;
2016-09-30 02:33:23 -07:00
// Template is the object that describes the pod that will be created if
// insufficient replicas are detected.
2018-07-03 00:37:22 -07:00
// More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template
2017-05-11 01:29:10 -07:00
// +optional
2018-07-03 00:37:22 -07:00
optional k8s.io.api.core.v1.PodTemplateSpec template = 3 ;
2016-09-30 02:33:23 -07:00
}
// ReplicaSetStatus represents the current status of a ReplicaSet.
message ReplicaSetStatus {
// Replicas is the most recently oberved number of replicas.
2018-07-03 00:37:22 -07:00
// More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller
2016-09-30 02:33:23 -07:00
optional int32 replicas = 1 ;
// The number of pods that have labels matching the labels of the pod template of the replicaset.
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
optional int32 fullyLabeledReplicas = 2 ;
// The number of ready replicas for this replica set.
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
optional int32 readyReplicas = 4 ;
2017-05-11 01:29:10 -07:00
// The number of available replicas (ready for at least minReadySeconds) for this replica set.
// +optional
optional int32 availableReplicas = 5 ;
2016-09-30 02:33:23 -07:00
// ObservedGeneration reflects the generation of the most recently observed ReplicaSet.
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
optional int64 observedGeneration = 3 ;
2017-05-11 01:29:10 -07:00
// Represents the latest available observations of a replica set's current state.
// +optional
2018-07-03 00:37:22 -07:00
// +patchMergeKey=type
// +patchStrategy=merge
2017-05-11 01:29:10 -07:00
repeated ReplicaSetCondition conditions = 6 ;
2016-09-30 02:33:23 -07:00
}
2018-07-03 00:37:22 -07:00
// DEPRECATED.
2016-09-30 02:33:23 -07:00
message RollbackConfig {
2018-07-03 00:37:22 -07:00
// The revision to rollback to. If set to 0, rollback to the last revision.
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
optional int64 revision = 1 ;
}
2017-05-11 01:29:10 -07:00
// Spec to control the desired behavior of daemon set rolling update.
message RollingUpdateDaemonSet {
// The maximum number of DaemonSet pods that can be unavailable during the
// update. Value can be an absolute number (ex: 5) or a percentage of total
// number of DaemonSet pods at the start of the update (ex: 10%). Absolute
// number is calculated from percentage by rounding up.
// This cannot be 0.
// Default value is 1.
// Example: when this is set to 30%, at most 30% of the total number of nodes
// that should be running the daemon pod (i.e. status.desiredNumberScheduled)
// can have their pods stopped for an update at any given
// time. The update starts by stopping at most 30% of those DaemonSet pods
// and then brings up new DaemonSet pods in their place. Once the new pods
// are available, it then proceeds onto other DaemonSet pods, thus ensuring
// that at least 70% of original number of DaemonSet pods are available at
// all times during the update.
// +optional
optional k8s.io.apimachinery.pkg.util.intstr.IntOrString maxUnavailable = 1 ;
}
2016-09-30 02:33:23 -07:00
// Spec to control the desired behavior of rolling update.
message RollingUpdateDeployment {
// The maximum number of pods that can be unavailable during the update.
// Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).
2017-05-11 01:29:10 -07:00
// Absolute number is calculated from percentage by rounding down.
2016-09-30 02:33:23 -07:00
// This can not be 0 if MaxSurge is 0.
// By default, a fixed value of 1 is used.
// Example: when this is set to 30%, the old RC can be scaled down to 70% of desired pods
// immediately when the rolling update starts. Once new pods are ready, old RC
// can be scaled down further, followed by scaling up the new RC, ensuring
// that the total number of pods available at all times during the update is at
// least 70% of desired pods.
2017-05-11 01:29:10 -07:00
// +optional
optional k8s.io.apimachinery.pkg.util.intstr.IntOrString maxUnavailable = 1 ;
2016-09-30 02:33:23 -07:00
// The maximum number of pods that can be scheduled above the desired number of
// pods.
// Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).
// This can not be 0 if MaxUnavailable is 0.
// Absolute number is calculated from percentage by rounding up.
// By default, a value of 1 is used.
// Example: when this is set to 30%, the new RC can be scaled up immediately when
// the rolling update starts, such that the total number of old and new pods do not exceed
// 130% of desired pods. Once old pods have been killed,
// new RC can be scaled up further, ensuring that total number of pods running
2019-04-18 13:59:29 -07:00
// at any time during the update is at most 130% of desired pods.
2017-05-11 01:29:10 -07:00
// +optional
optional k8s.io.apimachinery.pkg.util.intstr.IntOrString maxSurge = 2 ;
2016-09-30 02:33:23 -07:00
}
2018-12-03 19:19:44 -08:00
// RunAsGroupStrategyOptions defines the strategy type and any options used to create the strategy.
// Deprecated: use RunAsGroupStrategyOptions from policy API Group instead.
message RunAsGroupStrategyOptions {
// rule is the strategy that will dictate the allowable RunAsGroup values that may be set.
optional string rule = 1 ;
// ranges are the allowed ranges of gids that may be used. If you would like to force a single gid
// then supply a single range with the same start and end. Required for MustRunAs.
// +optional
repeated IDRange ranges = 2 ;
}
2018-07-03 00:37:22 -07:00
// RunAsUserStrategyOptions defines the strategy type and any options used to create the strategy.
// Deprecated: use RunAsUserStrategyOptions from policy API Group instead.
2016-09-30 02:33:23 -07:00
message RunAsUserStrategyOptions {
2018-07-03 00:37:22 -07:00
// rule is the strategy that will dictate the allowable RunAsUser values that may be set.
2016-09-30 02:33:23 -07:00
optional string rule = 1 ;
2018-07-03 00:37:22 -07:00
// ranges are the allowed ranges of uids that may be used. If you would like to force a single uid
// then supply a single range with the same start and end. Required for MustRunAs.
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
repeated IDRange ranges = 2 ;
}
2019-07-18 13:39:06 -07:00
// RuntimeClassStrategyOptions define the strategy that will dictate the allowable RuntimeClasses
// for a pod.
message RuntimeClassStrategyOptions {
// allowedRuntimeClassNames is a whitelist of RuntimeClass names that may be specified on a pod.
// A value of "*" means that any RuntimeClass name is allowed, and must be the only item in the
// list. An empty list requires the RuntimeClassName field to be unset.
repeated string allowedRuntimeClassNames = 1 ;
// defaultRuntimeClassName is the default RuntimeClassName to set on the pod.
// The default MUST be allowed by the allowedRuntimeClassNames list.
// A value of nil does not mutate the Pod.
// +optional
optional string defaultRuntimeClassName = 2 ;
}
2018-07-03 00:37:22 -07:00
// SELinuxStrategyOptions defines the strategy type and any options used to create the strategy.
// Deprecated: use SELinuxStrategyOptions from policy API Group instead.
2016-09-30 02:33:23 -07:00
message SELinuxStrategyOptions {
2018-07-03 00:37:22 -07:00
// rule is the strategy that will dictate the allowable labels that may be set.
2016-09-30 02:33:23 -07:00
optional string rule = 1 ;
// seLinuxOptions required to run as; required for MustRunAs
2018-07-03 00:37:22 -07:00
// More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
2017-05-11 01:29:10 -07:00
// +optional
2018-07-03 00:37:22 -07:00
optional k8s.io.api.core.v1.SELinuxOptions seLinuxOptions = 2 ;
2016-09-30 02:33:23 -07:00
}
// represents a scaling request for a resource.
message Scale {
2019-04-18 13:59:29 -07:00
// Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.
2017-05-11 01:29:10 -07:00
// +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1 ;
2016-09-30 02:33:23 -07:00
2019-04-18 13:59:29 -07:00
// defines the behavior of the scale. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status.
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
optional ScaleSpec spec = 2 ;
2019-04-18 13:59:29 -07:00
// current status of the scale. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. Read-only.
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
optional ScaleStatus status = 3 ;
}
// describes the attributes of a scale subresource
message ScaleSpec {
// desired number of instances for the scaled object.
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
optional int32 replicas = 1 ;
}
// represents the current status of a scale subresource.
message ScaleStatus {
// actual number of observed instances of the scaled object.
optional int32 replicas = 1 ;
2017-05-11 01:29:10 -07:00
// label query over pods that should match the replicas count. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors
// +optional
2016-09-30 02:33:23 -07:00
map < string , string > selector = 2 ;
// label selector for pods that should match the replicas count. This is a serializated
// version of both map-based and more expressive set-based selectors. This is done to
// avoid introspection in the clients. The string will be in the same format as the
// query-param syntax. If the target type only supports map-based selectors, both this
// field and map-based selector field are populated.
2018-07-03 00:37:22 -07:00
// More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
optional string targetSelector = 3 ;
}
// SupplementalGroupsStrategyOptions defines the strategy type and options used to create the strategy.
2018-07-03 00:37:22 -07:00
// Deprecated: use SupplementalGroupsStrategyOptions from policy API Group instead.
2016-09-30 02:33:23 -07:00
message SupplementalGroupsStrategyOptions {
2018-07-03 00:37:22 -07:00
// rule is the strategy that will dictate what supplemental groups is used in the SecurityContext.
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
optional string rule = 1 ;
2018-07-03 00:37:22 -07:00
// ranges are the allowed ranges of supplemental groups. If you would like to force a single
// supplemental group then supply a single range with the same start and end. Required for MustRunAs.
2017-05-11 01:29:10 -07:00
// +optional
2016-09-30 02:33:23 -07:00
repeated IDRange ranges = 2 ;
}