Class SecurityContext

  • All Implemented Interfaces:
    com.marcnuri.yakc.model.Model

    public class SecurityContext
    extends java.lang.Object
    implements com.marcnuri.yakc.model.Model
    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.
    • Constructor Detail

      • SecurityContext

        public SecurityContext​(java.lang.Boolean allowPrivilegeEscalation,
                               Capabilities capabilities,
                               java.lang.Boolean privileged,
                               java.lang.String procMount,
                               java.lang.Boolean readOnlyRootFilesystem,
                               java.lang.Number runAsGroup,
                               java.lang.Boolean runAsNonRoot,
                               java.lang.Number runAsUser,
                               SELinuxOptions seLinuxOptions,
                               SeccompProfile seccompProfile,
                               WindowsSecurityContextOptions windowsOptions)
      • SecurityContext

        public SecurityContext()
    • Method Detail

      • getAllowPrivilegeEscalation

        public java.lang.Boolean getAllowPrivilegeEscalation()
        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 Note that this field cannot be set when spec.os.name is windows.
      • getPrivileged

        public java.lang.Boolean getPrivileged()
        Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.
      • getProcMount

        public java.lang.String getProcMount()
        procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.
      • getReadOnlyRootFilesystem

        public java.lang.Boolean getReadOnlyRootFilesystem()
        Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.
      • getRunAsGroup

        public java.lang.Number getRunAsGroup()
        The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
      • getRunAsNonRoot

        public java.lang.Boolean getRunAsNonRoot()
        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.
      • getRunAsUser

        public java.lang.Number getRunAsUser()
        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. Note that this field cannot be set when spec.os.name is windows.
      • setAllowPrivilegeEscalation

        public void setAllowPrivilegeEscalation​(java.lang.Boolean allowPrivilegeEscalation)
        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 Note that this field cannot be set when spec.os.name is windows.
      • setCapabilities

        public void setCapabilities​(Capabilities capabilities)
      • setPrivileged

        public void setPrivileged​(java.lang.Boolean privileged)
        Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.
      • setProcMount

        public void setProcMount​(java.lang.String procMount)
        procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.
      • setReadOnlyRootFilesystem

        public void setReadOnlyRootFilesystem​(java.lang.Boolean readOnlyRootFilesystem)
        Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.
      • setRunAsGroup

        public void setRunAsGroup​(java.lang.Number runAsGroup)
        The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.
      • setRunAsNonRoot

        public void setRunAsNonRoot​(java.lang.Boolean runAsNonRoot)
        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.
      • setRunAsUser

        public void setRunAsUser​(java.lang.Number runAsUser)
        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. Note that this field cannot be set when spec.os.name is windows.
      • setSeLinuxOptions

        public void setSeLinuxOptions​(SELinuxOptions seLinuxOptions)
      • setSeccompProfile

        public void setSeccompProfile​(SeccompProfile seccompProfile)
      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object
      • canEqual

        protected boolean canEqual​(java.lang.Object other)
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object