v1beta1

package
v1.17.0-kw10 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 29, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

View Source 
const GroupName = "policy"

GroupName is the group name use in this package

Variables

View Source 
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1beta1"}

SchemeGroupVersion is group version used to register these objects

Functions

func Resource 

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type AllowedCSIDriver 

type AllowedCSIDriver struct {

	// Name is the registered name of the CSI driver
	// Required: true
	Name *string `json:"name"`
}

AllowedCSIDriver AllowedCSIDriver represents a single inline CSI Driver that is allowed to be used.

swagger:model AllowedCSIDriver

type AllowedFlexVolume 

type AllowedFlexVolume struct {

	// driver is the name of the Flexvolume driver.
	// Required: true
	Driver *string `json:"driver"`
}

AllowedFlexVolume AllowedFlexVolume represents a single Flexvolume that is allowed to be used.

swagger:model AllowedFlexVolume

type AllowedHostPath 

type AllowedHostPath struct {

	// 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.
	//
	// Examples: `/foo` would allow `/foo`, `/foo/` and `/foo/bar` `/foo` would not allow `/food` or `/etc/foo`
	PathPrefix string `json:"pathPrefix,omitempty"`

	// when set to true, will allow host volumes matching the pathPrefix only if all volume mounts are readOnly.
	ReadOnly bool `json:"readOnly,omitempty"`
}

AllowedHostPath 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.

swagger:model AllowedHostPath

type Eviction 

type Eviction struct {

	// 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/sig-architecture/api-conventions.md#resources
	APIVersion string `json:"apiVersion,omitempty"`

	// DeleteOptions may be provided
	DeleteOptions *apimachinery_pkg_apis_meta_v1.DeleteOptions `json:"deleteOptions,omitempty"`

	// 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/sig-architecture/api-conventions.md#types-kinds
	Kind string `json:"kind,omitempty"`

	// ObjectMeta describes the pod that is being evicted.
	Metadata *apimachinery_pkg_apis_meta_v1.ObjectMeta `json:"metadata,omitempty"`
}

Eviction Eviction evicts a pod from its node subject to certain policies and safety constraints. This is a subresource of Pod. A request to cause such an eviction is created by POSTing to .../pods/<pod name>/evictions.

swagger:model Eviction

func (*Eviction) GroupVersionKind 

func (v *Eviction) GroupVersionKind() schema.GroupVersionKind

type FSGroupStrategyOptions 

type FSGroupStrategyOptions struct {

	// 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.
	Ranges []*IDRange `json:"ranges,omitempty"`

	// rule is the strategy that will dictate what FSGroup is used in the SecurityContext.
	Rule string `json:"rule,omitempty"`
}

FSGroupStrategyOptions FSGroupStrategyOptions defines the strategy type and options used to create the strategy.

swagger:model FSGroupStrategyOptions

type HostPortRange 

type HostPortRange struct {

	// max is the end of the range, inclusive.
	// Required: true
	Max *int32 `json:"max"`

	// min is the start of the range, inclusive.
	// Required: true
	Min *int32 `json:"min"`
}

HostPortRange HostPortRange defines a range of host ports that will be enabled by a policy for pods to use. It requires both the start and end to be defined.

swagger:model HostPortRange

type IDRange 

type IDRange struct {

	// max is the end of the range, inclusive.
	// Required: true
	Max *int64 `json:"max"`

	// min is the start of the range, inclusive.
	// Required: true
	Min *int64 `json:"min"`
}

IDRange IDRange provides a min/max of an allowed range of IDs.

swagger:model IDRange

type PodDisruptionBudget 

type PodDisruptionBudget struct {

	// 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/sig-architecture/api-conventions.md#resources
	APIVersion string `json:"apiVersion,omitempty"`

	// 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/sig-architecture/api-conventions.md#types-kinds
	Kind string `json:"kind,omitempty"`

	// metadata
	Metadata *apimachinery_pkg_apis_meta_v1.ObjectMeta `json:"metadata,omitempty"`

	// Specification of the desired behavior of the PodDisruptionBudget.
	Spec *PodDisruptionBudgetSpec `json:"spec,omitempty"`

	// Most recently observed status of the PodDisruptionBudget.
	Status *PodDisruptionBudgetStatus `json:"status,omitempty"`
}

PodDisruptionBudget PodDisruptionBudget is an object to define the max disruption that can be caused to a collection of pods

swagger:model PodDisruptionBudget

func (*PodDisruptionBudget) GroupVersionKind 

func (v *PodDisruptionBudget) GroupVersionKind() schema.GroupVersionKind

type PodDisruptionBudgetList 

type PodDisruptionBudgetList struct {

	// 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/sig-architecture/api-conventions.md#resources
	APIVersion string `json:"apiVersion,omitempty"`

	// items
	// Required: true
	Items []*PodDisruptionBudget `json:"items"`

	// 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/sig-architecture/api-conventions.md#types-kinds
	Kind string `json:"kind,omitempty"`

	// metadata
	Metadata *apimachinery_pkg_apis_meta_v1.ListMeta `json:"metadata,omitempty"`
}

PodDisruptionBudgetList PodDisruptionBudgetList is a collection of PodDisruptionBudgets.

swagger:model PodDisruptionBudgetList

func (*PodDisruptionBudgetList) GroupVersionKind 

func (v *PodDisruptionBudgetList) GroupVersionKind() schema.GroupVersionKind

type PodDisruptionBudgetSpec 

type PodDisruptionBudgetSpec struct {

	// An eviction is allowed if at most "maxUnavailable" pods selected by "selector" are unavailable after the eviction, i.e. even in absence of the evicted pod. For example, one can prevent all voluntary evictions by specifying 0. This is a mutually exclusive setting with "minAvailable".
	MaxUnavailable *apimachinery_pkg_util_intstr.IntOrString `json:"maxUnavailable,omitempty"`

	// An eviction is allowed if at least "minAvailable" pods selected by "selector" will still be available after the eviction, i.e. even in the absence of the evicted pod.  So for example you can prevent all voluntary evictions by specifying "100%".
	MinAvailable *apimachinery_pkg_util_intstr.IntOrString `json:"minAvailable,omitempty"`

	// Label query over pods whose evictions are managed by the disruption budget.
	Selector *apimachinery_pkg_apis_meta_v1.LabelSelector `json:"selector,omitempty"`
}

PodDisruptionBudgetSpec PodDisruptionBudgetSpec is a description of a PodDisruptionBudget.

swagger:model PodDisruptionBudgetSpec

type PodDisruptionBudgetStatus 

type PodDisruptionBudgetStatus struct {

	// current number of healthy pods
	// Required: true
	CurrentHealthy *int32 `json:"currentHealthy"`

	// minimum desired number of healthy pods
	// Required: true
	DesiredHealthy *int32 `json:"desiredHealthy"`

	// DisruptedPods contains information about pods whose eviction was processed by the API server eviction subresource handler but has not yet been observed by the PodDisruptionBudget controller. A pod will be in this map from the time when the API server processed the eviction request to the time when the pod is seen by PDB controller as having been marked for deletion (or after a timeout). The key in the map is the name of the pod and the value is the time when the API server processed the eviction request. If the deletion didn't occur and a pod is still there it will be removed from the list automatically by PodDisruptionBudget controller after some time. If everything goes smooth this map should be empty for the most of the time. Large number of entries in the map may indicate problems with pod deletions.
	DisruptedPods map[string]*apimachinery_pkg_apis_meta_v1.Time `json:"disruptedPods,omitempty"`

	// Number of pod disruptions that are currently allowed.
	// Required: true
	DisruptionsAllowed *int32 `json:"disruptionsAllowed"`

	// total number of pods counted by this disruption budget
	// Required: true
	ExpectedPods *int32 `json:"expectedPods"`

	// Most recent generation observed when updating this PDB status. PodDisruptionsAllowed and other status information is valid only if observedGeneration equals to PDB's object generation.
	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
}

PodDisruptionBudgetStatus PodDisruptionBudgetStatus represents information about the status of a PodDisruptionBudget. Status may trail the actual state of a system.

swagger:model PodDisruptionBudgetStatus

type PodSecurityPolicy 

type PodSecurityPolicy struct {

	// 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/sig-architecture/api-conventions.md#resources
	APIVersion string `json:"apiVersion,omitempty"`

	// 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/sig-architecture/api-conventions.md#types-kinds
	Kind string `json:"kind,omitempty"`

	// Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
	Metadata *apimachinery_pkg_apis_meta_v1.ObjectMeta `json:"metadata,omitempty"`

	// spec defines the policy enforced.
	Spec *PodSecurityPolicySpec `json:"spec,omitempty"`
}

PodSecurityPolicy PodSecurityPolicy governs the ability to make requests that affect the Security Context that will be applied to a pod and container.

swagger:model PodSecurityPolicy

func (*PodSecurityPolicy) GroupVersionKind 

func (v *PodSecurityPolicy) GroupVersionKind() schema.GroupVersionKind

type PodSecurityPolicyList 

type PodSecurityPolicyList struct {

	// 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/sig-architecture/api-conventions.md#resources
	APIVersion string `json:"apiVersion,omitempty"`

	// items is a list of schema objects.
	// Required: true
	Items []*PodSecurityPolicy `json:"items"`

	// 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/sig-architecture/api-conventions.md#types-kinds
	Kind string `json:"kind,omitempty"`

	// Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
	Metadata *apimachinery_pkg_apis_meta_v1.ListMeta `json:"metadata,omitempty"`
}

PodSecurityPolicyList PodSecurityPolicyList is a list of PodSecurityPolicy objects.

swagger:model PodSecurityPolicyList

func (*PodSecurityPolicyList) GroupVersionKind 

func (v *PodSecurityPolicyList) GroupVersionKind() schema.GroupVersionKind

type PodSecurityPolicySpec 

type PodSecurityPolicySpec struct {

	// allowPrivilegeEscalation determines if a pod can request to allow privilege escalation. If unspecified, defaults to true.
	AllowPrivilegeEscalation bool `json:"allowPrivilegeEscalation,omitempty"`

	// AllowedCSIDrivers is a whitelist of inline CSI drivers that must be explicitly set to be embedded within a pod spec. An empty value indicates that any CSI driver can be used for inline ephemeral volumes. This is an alpha field, and is only honored if the API server enables the CSIInlineVolume feature gate.
	AllowedCSIDrivers []*AllowedCSIDriver `json:"allowedCSIDrivers,omitempty"`

	// allowedCapabilities is a list of capabilities that can be requested to add to the container. Capabilities in this field may be added at the pod author's discretion. You must not list a capability in both allowedCapabilities and requiredDropCapabilities.
	AllowedCapabilities []string `json:"allowedCapabilities,omitempty"`

	// 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.
	AllowedFlexVolumes []*AllowedFlexVolume `json:"allowedFlexVolumes,omitempty"`

	// allowedHostPaths is a white list of allowed host paths. Empty indicates that all host paths may be used.
	AllowedHostPaths []*AllowedHostPath `json:"allowedHostPaths,omitempty"`

	// 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.
	AllowedProcMountTypes []string `json:"allowedProcMountTypes,omitempty"`

	// 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.
	//
	// Examples: e.g. "foo/*" allows "foo/bar", "foo/baz", etc. e.g. "foo.*" allows "foo.bar", "foo.baz", etc.
	AllowedUnsafeSysctls []string `json:"allowedUnsafeSysctls,omitempty"`

	// 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.
	DefaultAddCapabilities []string `json:"defaultAddCapabilities,omitempty"`

	// defaultAllowPrivilegeEscalation controls the default setting for whether a process can gain more privileges than its parent process.
	DefaultAllowPrivilegeEscalation bool `json:"defaultAllowPrivilegeEscalation,omitempty"`

	// 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.
	//
	// Examples: e.g. "foo/*" forbids "foo/bar", "foo/baz", etc. e.g. "foo.*" forbids "foo.bar", "foo.baz", etc.
	ForbiddenSysctls []string `json:"forbiddenSysctls,omitempty"`

	// fsGroup is the strategy that will dictate what fs group is used by the SecurityContext.
	// Required: true
	FSGroup *FSGroupStrategyOptions `json:"fsGroup"`

	// hostIPC determines if the policy allows the use of HostIPC in the pod spec.
	HostIPC bool `json:"hostIPC,omitempty"`

	// hostNetwork determines if the policy allows the use of HostNetwork in the pod spec.
	HostNetwork bool `json:"hostNetwork,omitempty"`

	// hostPID determines if the policy allows the use of HostPID in the pod spec.
	HostPID bool `json:"hostPID,omitempty"`

	// hostPorts determines which host port ranges are allowed to be exposed.
	HostPorts []*HostPortRange `json:"hostPorts,omitempty"`

	// privileged determines if a pod can request to be run as privileged.
	Privileged bool `json:"privileged,omitempty"`

	// readOnlyRootFilesystem when set to true will force containers to run with a read only root file 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.
	ReadOnlyRootFilesystem bool `json:"readOnlyRootFilesystem,omitempty"`

	// requiredDropCapabilities are the capabilities that will be dropped from the container.  These are required to be dropped and cannot be added.
	RequiredDropCapabilities []string `json:"requiredDropCapabilities,omitempty"`

	// 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.
	RunAsGroup *RunAsGroupStrategyOptions `json:"runAsGroup,omitempty"`

	// runAsUser is the strategy that will dictate the allowable RunAsUser values that may be set.
	// Required: true
	RunAsUser *RunAsUserStrategyOptions `json:"runAsUser"`

	// 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.
	RuntimeClass *RuntimeClassStrategyOptions `json:"runtimeClass,omitempty"`

	// seLinux is the strategy that will dictate the allowable labels that may be set.
	// Required: true
	SELinux *SELinuxStrategyOptions `json:"seLinux"`

	// supplementalGroups is the strategy that will dictate what supplemental groups are used by the SecurityContext.
	// Required: true
	SupplementalGroups *SupplementalGroupsStrategyOptions `json:"supplementalGroups"`

	// volumes is a white list of allowed volume plugins. Empty indicates that no volumes may be used. To allow all volumes you may use '*'.
	Volumes []string `json:"volumes,omitempty"`
}

PodSecurityPolicySpec PodSecurityPolicySpec defines the policy enforced.

swagger:model PodSecurityPolicySpec

type RunAsGroupStrategyOptions 

type RunAsGroupStrategyOptions struct {

	// 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.
	Ranges []*IDRange `json:"ranges,omitempty"`

	// rule is the strategy that will dictate the allowable RunAsGroup values that may be set.
	// Required: true
	Rule *string `json:"rule"`
}

RunAsGroupStrategyOptions RunAsGroupStrategyOptions defines the strategy type and any options used to create the strategy.

swagger:model RunAsGroupStrategyOptions

type RunAsUserStrategyOptions 

type RunAsUserStrategyOptions struct {

	// 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.
	Ranges []*IDRange `json:"ranges,omitempty"`

	// rule is the strategy that will dictate the allowable RunAsUser values that may be set.
	// Required: true
	Rule *string `json:"rule"`
}

RunAsUserStrategyOptions RunAsUserStrategyOptions defines the strategy type and any options used to create the strategy.

swagger:model RunAsUserStrategyOptions

type RuntimeClassStrategyOptions 

type RuntimeClassStrategyOptions struct {

	// 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.
	// Required: true
	AllowedRuntimeClassNames []string `json:"allowedRuntimeClassNames"`

	// 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.
	DefaultRuntimeClassName string `json:"defaultRuntimeClassName,omitempty"`
}

RuntimeClassStrategyOptions RuntimeClassStrategyOptions define the strategy that will dictate the allowable RuntimeClasses for a pod.

swagger:model RuntimeClassStrategyOptions

type SELinuxStrategyOptions 

type SELinuxStrategyOptions struct {

	// rule is the strategy that will dictate the allowable labels that may be set.
	// Required: true
	Rule *string `json:"rule"`

	// seLinuxOptions required to run as; required for MustRunAs More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
	SELinuxOptions *api_core_v1.SELinuxOptions `json:"seLinuxOptions,omitempty"`
}

SELinuxStrategyOptions SELinuxStrategyOptions defines the strategy type and any options used to create the strategy.

swagger:model SELinuxStrategyOptions

type SupplementalGroupsStrategyOptions 

type SupplementalGroupsStrategyOptions struct {

	// 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.
	Ranges []*IDRange `json:"ranges,omitempty"`

	// rule is the strategy that will dictate what supplemental groups is used in the SecurityContext.
	Rule string `json:"rule,omitempty"`
}

SupplementalGroupsStrategyOptions SupplementalGroupsStrategyOptions defines the strategy type and options used to create the strategy.

swagger:model SupplementalGroupsStrategyOptions

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.