Create Fargate Profile
eks_create_fargate_profile | R Documentation |
Creates an Fargate profile for your Amazon EKS cluster¶
Description¶
Creates an Fargate profile for your Amazon EKS cluster. You must have at least one Fargate profile in a cluster to be able to run pods on Fargate.
The Fargate profile allows an administrator to declare which pods run on Fargate and specify which pods run on which Fargate profile. This declaration is done through the profile’s selectors. Each profile can have up to five selectors that contain a namespace and labels. A namespace is required for every selector. The label field consists of multiple optional key-value pairs. Pods that match the selectors are scheduled on Fargate. If a to-be-scheduled pod matches any of the selectors in the Fargate profile, then that pod is run on Fargate.
When you create a Fargate profile, you must specify a pod execution role
to use with the pods that are scheduled with the profile. This role is
added to the cluster's Kubernetes Role Based Access
Control
(RBAC) for authorization so that the kubelet
that is running on the
Fargate infrastructure can register with your Amazon EKS cluster so that
it can appear in your cluster as a node. The pod execution role also
provides IAM permissions to the Fargate infrastructure to allow read
access to Amazon ECR image repositories. For more information, see Pod
Execution
Role
in the Amazon EKS User Guide.
Fargate profiles are immutable. However, you can create a new updated profile to replace an existing profile and then delete the original after the updated profile has finished creating.
If any Fargate profiles in a cluster are in the DELETING
status, you
must wait for that Fargate profile to finish deleting before you can
create any other profiles in that cluster.
For more information, see Fargate profile in the Amazon EKS User Guide.
Usage¶
eks_create_fargate_profile(fargateProfileName, clusterName,
podExecutionRoleArn, subnets, selectors, clientRequestToken, tags)
Arguments¶
fargateProfileName
[required] The name of the Fargate profile.
clusterName
[required] The name of your cluster.
podExecutionRoleArn
[required] The Amazon Resource Name (ARN) of the
Pod
execution role to use for aPod
that matches the selectors in the Fargate profile. ThePod
execution role allows Fargate infrastructure to register with your cluster as a node, and it provides read access to Amazon ECR image repositories. For more information, seePod
execution role in the Amazon EKS User Guide.subnets
The IDs of subnets to launch a
Pod
into. APod
running on Fargate isn't assigned a public IP address, so only private subnets (with no direct route to an Internet Gateway) are accepted for this parameter.selectors
The selectors to match for a
Pod
to use this Fargate profile. Each selector must have an associated Kubernetesnamespace
. Optionally, you can also specifylabels
for anamespace
. You may specify up to five selectors in a Fargate profile.clientRequestToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
tags
Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon Web Services resources.
Value¶
A list with the following syntax:
list(
fargateProfile = list(
fargateProfileName = "string",
fargateProfileArn = "string",
clusterName = "string",
createdAt = as.POSIXct(
"2015-01-01"
),
podExecutionRoleArn = "string",
subnets = list(
"string"
),
selectors = list(
list(
namespace = "string",
labels = list(
"string"
)
)
),
status = "CREATING"|"ACTIVE"|"DELETING"|"CREATE_FAILED"|"DELETE_FAILED",
tags = list(
"string"
),
health = list(
issues = list(
list(
code = "PodExecutionRoleAlreadyInUse"|"AccessDenied"|"ClusterUnreachable"|"InternalFailure",
message = "string",
resourceIds = list(
"string"
)
)
)
)
)
)