Update documentation for initial Fargate release

This commit is contained in:
Onur Filiz
2018-04-25 00:40:37 -07:00
committed by Robbie Zhang
parent 22bafee6a8
commit 7628b62bce
3 changed files with 95 additions and 30 deletions

View File

@@ -1,5 +1,5 @@
#
# Example configuration file for virtual-kubelet AWS Fargate provider.
# Example configuration file for AWS Fargate virtual-kubelet provider.
#
# Usage:
# virtual-kubelet --provider aws --provider-config fargate.toml
@@ -8,38 +8,40 @@
# AWS region where Fargate resources are provisioned. Mandatory.
Region = "us-east-1"
# Fargate cluster name. Optional. Defaults to "default".
# AWS Fargate cluster name. Optional. Defaults to "default".
# If a cluster with this name does not exist in the region, virtual-kubelet will create it.
# Although the same Fargate cluster can be shared by multiple virtual-kubelets,
# we recommend to create a dedicated Fargate cluster for each virtual-kubelet.
ClusterName = "fargate1"
# Creating a dedicated Fargate cluster for each virtual-kubelet is recommended.
ClusterName = "default"
# List of subnets that pods are connected to. Mandatory.
# List of subnets that pod ENIs are connected to. Mandatory.
Subnets = ["subnet-12345678"]
# List of security groups for pods. Optional.
# If omitted, pods inherit their VPC's default security group.
SecurityGroups = ["sg-12345678", "sg-87654321"]
# List of security groups associated with pod ENIs. Optional.
# If omitted, pod ENIs inherit their VPC's default security group.
SecurityGroups = ["sg-12345678"]
# Whether pod ENIs are assigned a public IPv4 address. Optional. Defaults to false.
# If your pod requires internet access (e.g. to download container images from ECR or Docker Hub),
# this should be set to "true" for pods on public subnets with internet gateways,
# and to "false" for pods on private subnets with NAT gateways.
AssignPublicIPv4Address = false
# Role assumed by AWS Fargate to execute your task. Optional.
# Role assumed by AWS Fargate to execute your pod. Optional.
# https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html
ExecutionRoleArn = ""
# AWS CloudWatch Log Group Name used to store container logs. Optional.
# If omitted, no container logs will be stored and retrievable.
CloudWatchLogGroupName = "/ecs/virtual-kubelet-logs"
# Amazon CloudWatch log group name used to store container logs. Optional.
# If omitted, container logs will not be available.
CloudWatchLogGroupName = ""
# Fargate platform version. Optional. Defaults to "LATEST".
# AWS Fargate platform version. Optional. Defaults to "LATEST".
# https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html
PlatformVersion = "LATEST"
# Operating system for pods. Optional. Defaults to "Linux".
OperatingSystem = "Linux"
# Fargate capacity advertised by virtual-kubelet. Optional. Defaults to the values below.
# AWS Fargate capacity advertised by virtual-kubelet. Optional. Defaults to the values below.
# Capacity is specified using Kubernetes resource format.
# https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
CPU = "20"