Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data EksContainer = EksContainer' {}
- newEksContainer :: Text -> EksContainer
- eksContainer_args :: Lens' EksContainer (Maybe [Text])
- eksContainer_command :: Lens' EksContainer (Maybe [Text])
- eksContainer_env :: Lens' EksContainer (Maybe [EksContainerEnvironmentVariable])
- eksContainer_imagePullPolicy :: Lens' EksContainer (Maybe Text)
- eksContainer_name :: Lens' EksContainer (Maybe Text)
- eksContainer_resources :: Lens' EksContainer (Maybe EksContainerResourceRequirements)
- eksContainer_securityContext :: Lens' EksContainer (Maybe EksContainerSecurityContext)
- eksContainer_volumeMounts :: Lens' EksContainer (Maybe [EksContainerVolumeMount])
- eksContainer_image :: Lens' EksContainer Text
Documentation
data EksContainer Source #
EKS container properties are used in job definitions for Amazon EKS based job definitions to describe the properties for a container node in the pod that's launched as part of a job. This can't be specified for Amazon ECS based job definitions.
See: newEksContainer
smart constructor.
EksContainer' | |
|
Instances
Create a value of EksContainer
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:args:EksContainer'
, eksContainer_args
- An array of arguments to the entrypoint. If this isn't specified, the
CMD
of the container image is used. This corresponds to the args
member in the
Entrypoint
portion of the
Pod
in Kubernetes. Environment variable references are expanded using the
container's environment.
If the referenced environment variable doesn't exist, the reference in
the command isn't changed. For example, if the reference is to
"$(NAME1)
" and the NAME1
environment variable doesn't exist, the
command string will remain "$(NAME1)
." $$
is replaced with $
,
and the resulting string isn't expanded. For example, $$(VAR_NAME)
is
passed as $(VAR_NAME)
whether or not the VAR_NAME
environment
variable exists. For more information, see
CMD in the
Dockerfile reference and
Define a command and arguments for a pod
in the Kubernetes documentation.
$sel:command:EksContainer'
, eksContainer_command
- The entrypoint for the container. This isn't run within a shell. If
this isn't specified, the ENTRYPOINT
of the container image is used.
Environment variable references are expanded using the container's
environment.
If the referenced environment variable doesn't exist, the reference in
the command isn't changed. For example, if the reference is to
"$(NAME1)
" and the NAME1
environment variable doesn't exist, the
command string will remain "$(NAME1)
." $$
is replaced with $
and
the resulting string isn't expanded. For example, $$(VAR_NAME)
will
be passed as $(VAR_NAME)
whether or not the VAR_NAME
environment
variable exists. The entrypoint can't be updated. For more information,
see
ENTRYPOINT
in the Dockerfile reference and
Define a command and arguments for a container
and
Entrypoint
in the Kubernetes documentation.
$sel:env:EksContainer'
, eksContainer_env
- The environment variables to pass to a container.
Environment variables cannot start with "AWS_BATCH
". This naming
convention is reserved for variables that Batch sets.
$sel:imagePullPolicy:EksContainer'
, eksContainer_imagePullPolicy
- The image pull policy for the container. Supported values are Always
,
IfNotPresent
, and Never
. This parameter defaults to IfNotPresent
.
However, if the :latest
tag is specified, it defaults to Always
. For
more information, see
Updating images
in the Kubernetes documentation.
EksContainer
, eksContainer_name
- The name of the container. If the name isn't specified, the default
name "Default
" is used. Each container in a pod must have a unique
name.
$sel:resources:EksContainer'
, eksContainer_resources
- The type and amount of resources to assign to a container. The supported
resources include memory
, cpu
, and nvidia.com/gpu
. For more
information, see
Resource management for pods and containers
in the Kubernetes documentation.
$sel:securityContext:EksContainer'
, eksContainer_securityContext
- The security context for a job. For more information, see
Configure a security context for a pod or container
in the Kubernetes documentation.
$sel:volumeMounts:EksContainer'
, eksContainer_volumeMounts
- The volume mounts for the container. Batch supports emptyDir
,
hostPath
, and secret
volume types. For more information about
volumes and volume mounts in Kubernetes, see
Volumes in the
Kubernetes documentation.
$sel:image:EksContainer'
, eksContainer_image
- The Docker image used to start the container.
eksContainer_args :: Lens' EksContainer (Maybe [Text]) Source #
An array of arguments to the entrypoint. If this isn't specified, the
CMD
of the container image is used. This corresponds to the args
member in the
Entrypoint
portion of the
Pod
in Kubernetes. Environment variable references are expanded using the
container's environment.
If the referenced environment variable doesn't exist, the reference in
the command isn't changed. For example, if the reference is to
"$(NAME1)
" and the NAME1
environment variable doesn't exist, the
command string will remain "$(NAME1)
." $$
is replaced with $
,
and the resulting string isn't expanded. For example, $$(VAR_NAME)
is
passed as $(VAR_NAME)
whether or not the VAR_NAME
environment
variable exists. For more information, see
CMD in the
Dockerfile reference and
Define a command and arguments for a pod
in the Kubernetes documentation.
eksContainer_command :: Lens' EksContainer (Maybe [Text]) Source #
The entrypoint for the container. This isn't run within a shell. If
this isn't specified, the ENTRYPOINT
of the container image is used.
Environment variable references are expanded using the container's
environment.
If the referenced environment variable doesn't exist, the reference in
the command isn't changed. For example, if the reference is to
"$(NAME1)
" and the NAME1
environment variable doesn't exist, the
command string will remain "$(NAME1)
." $$
is replaced with $
and
the resulting string isn't expanded. For example, $$(VAR_NAME)
will
be passed as $(VAR_NAME)
whether or not the VAR_NAME
environment
variable exists. The entrypoint can't be updated. For more information,
see
ENTRYPOINT
in the Dockerfile reference and
Define a command and arguments for a container
and
Entrypoint
in the Kubernetes documentation.
eksContainer_env :: Lens' EksContainer (Maybe [EksContainerEnvironmentVariable]) Source #
The environment variables to pass to a container.
Environment variables cannot start with "AWS_BATCH
". This naming
convention is reserved for variables that Batch sets.
eksContainer_imagePullPolicy :: Lens' EksContainer (Maybe Text) Source #
The image pull policy for the container. Supported values are Always
,
IfNotPresent
, and Never
. This parameter defaults to IfNotPresent
.
However, if the :latest
tag is specified, it defaults to Always
. For
more information, see
Updating images
in the Kubernetes documentation.
eksContainer_name :: Lens' EksContainer (Maybe Text) Source #
The name of the container. If the name isn't specified, the default
name "Default
" is used. Each container in a pod must have a unique
name.
eksContainer_resources :: Lens' EksContainer (Maybe EksContainerResourceRequirements) Source #
The type and amount of resources to assign to a container. The supported
resources include memory
, cpu
, and nvidia.com/gpu
. For more
information, see
Resource management for pods and containers
in the Kubernetes documentation.
eksContainer_securityContext :: Lens' EksContainer (Maybe EksContainerSecurityContext) Source #
The security context for a job. For more information, see Configure a security context for a pod or container in the Kubernetes documentation.
eksContainer_volumeMounts :: Lens' EksContainer (Maybe [EksContainerVolumeMount]) Source #
The volume mounts for the container. Batch supports emptyDir
,
hostPath
, and secret
volume types. For more information about
volumes and volume mounts in Kubernetes, see
Volumes in the
Kubernetes documentation.
eksContainer_image :: Lens' EksContainer Text Source #
The Docker image used to start the container.