github.com/giantswarm/apiextensions/v6@v6.6.0/pkg/annotation/aws.go (about) 1 package annotation 2 3 //Keep the YAML documentation format as it is used to render in the CRD public documentation. You can use Markdown in the documentation field. 4 5 // support: 6 // - crd: awsclusters.infrastructure.giantswarm.io 7 // apiversion: v1alpha2 8 // release: Since 14.0.0 9 // 10 // documentation: 11 // 12 // This annotation allows configuration of the MINIMUM_IP_TARGET parameter for AWS CNI. 13 // See [CNI Configuration Variables](https://github.com/aws/amazon-vpc-cni-k8s#cni-configuration-variables) 14 // and [ENI and IP Target](https://github.com/aws/amazon-vpc-cni-k8s/blob/master/docs/eni-and-ip-target.md) 15 const AWSCNIMinimumIPTarget = "alpha.cni.aws.giantswarm.io/minimum-ip-target" 16 17 // support: 18 // - crd: awscontrolplanes.infrastructure.giantswarm.io 19 // apiversion: v1alpha3 20 // release: Since 17.2.0 21 // 22 // documentation: 23 // 24 // This annotation enables alpha feature EBS Volume Iops. 25 const AWSEBSVolumeIops = "alpha.aws.giantswarm.io/ebs-volume-iops" 26 27 // support: 28 // - crd: awscontrolplanes.infrastructure.giantswarm.io 29 // apiversion: v1alpha3 30 // release: Since 17.2.0 31 // 32 // documentation: 33 // 34 // This annotation enables alpha feature EBS Volume Throughput. 35 const AWSEBSVolumeThroughput = "alpha.aws.giantswarm.io/ebs-volume-throughput" 36 37 // support: 38 // - crd: awsclusters.infrastructure.giantswarm.io 39 // apiversion: v1alpha2 40 // release: Since 16.1.0 41 // 42 // documentation: 43 // 44 // This annotation allows configuration of the ENABLE_PREFIX_DELEGATION parameter for AWS CNI. 45 // See [Enable Prefix Delegation](https://github.com/aws/amazon-vpc-cni-k8s#enable_prefix_delegation-v190) 46 const AWSCNIPrefixDelegation = "alpha.cni.aws.giantswarm.io/prefix-delegation" 47 48 // support: 49 // - crd: awsclusters.infrastructure.giantswarm.io 50 // apiversion: v1alpha2 51 // release: Since 14.0.0 52 // 53 // documentation: 54 // 55 // This annotation allows configuration of the WARM_IP_TARGET parameter for AWS CNI. 56 // See [CNI Configuration Variables](https://github.com/aws/amazon-vpc-cni-k8s#cni-configuration-variables) 57 // and [ENI and IP Target](https://github.com/aws/amazon-vpc-cni-k8s/blob/master/docs/eni-and-ip-target.md) 58 const AWSCNIWarmIPTarget = "alpha.cni.aws.giantswarm.io/warm-ip-target" 59 60 // support: 61 // - crd: awsclusters.infrastructure.giantswarm.io 62 // apiversion: v1alpha2 63 // release: Since 12.7.0 64 // - crd: awsmachinedeployments.infrastructure.giantswarm.io 65 // apiversion: v1alpha2 66 // release: Since 12.7.0 67 // 68 // documentation: 69 // 70 // This annotation is used for configuring maximum batch size for instances termination during ASG update. 71 // The value can be either a whole number specifying the number of instances 72 // or a percentage of total instances as decimal number ie `0.3` for 30%. 73 // See [fine-tuning upgrade disruption](https://docs.giantswarm.io/advanced/upgrade-disruption/) 74 // and [AWS documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html#cfn-attributes-updatepolicy-rollingupdate-maxbatchsize) for additional information. 75 const AWSUpdateMaxBatchSize = "alpha.aws.giantswarm.io/update-max-batch-size" 76 77 // support: 78 // - crd: awsclusters.infrastructure.giantswarm.io 79 // apiversion: v1alpha2 80 // release: Since 12.7.0 81 // - crd: awsmachinedeployments.infrastructure.giantswarm.io 82 // apiversion: v1alpha2 83 // release: Since 12.7.0 84 // 85 // documentation: 86 // 87 // This annotation is used for configuring time pause between rolling a single batch during ASG update. 88 // The value must be in ISO 8601 duration format, e. g. "PT5M" for five minutes or "PT10S" for 10 seconds. 89 // See [fine-tuning upgrade disruption](https://docs.giantswarm.io/advanced/upgrade-disruption/) 90 // and [AWS documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html#cfn-attributes-updatepolicy-rollingupdate-maxbatchsize) for additional information. 91 const AWSUpdatePauseTime = "alpha.aws.giantswarm.io/update-pause-time" 92 93 // Not documented as it's not usable. 94 // AWSMetadataV2 configures token usage for your AWS EC2 instance metadata requests. 95 // If the value is 'optional', you can choose to retrieve instance metadata with or without a signed token 96 // header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role 97 // credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 98 // 2.0 role credentials are returned. 99 // If the state is 'required', you must send a signed token header with any instance metadata retrieval 100 // requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the 101 // version 1.0 credentials are not available. 102 // Default value is 'optional' 103 // 104 // [AWS Documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-metadataoptions.html#cfn-ec2-launchtemplate-launchtemplatedata-metadataoptions-httptokens) 105 const AWSMetadataV2 = "alpha.aws.giantswarm.io/metadata-v2" 106 107 // support: 108 // - crd: awsclusters.infrastructure.giantswarm.io 109 // apiversion: v1alpha2 110 // release: Since 12.7.0 111 // - crd: awsmachinedeployments.infrastructure.giantswarm.io 112 // apiversion: v1alpha2 113 // release: Since 12.7.0 114 // 115 // documentation: 116 // 117 // This annotation is used to configure the workload cluster's control plane subnet size when used on an `AWSCluster` resource or to configure the workload cluster's node pool subnet size when used on an `AWSMachineDeployment` resource. 118 // The value is a number that will represent the subnet mask used when creating the subnet. It must be smaller than 28 due to AWS restrictions. 119 const AWSSubnetSize = "alpha.aws.giantswarm.io/aws-subnet-size" 120 121 // support: 122 // - crd: awscontrolplanes.infrastructure.giantswarm.io 123 // apiversion: v1alpha2 124 // release: Since 18.2.0 125 // - crd: awsmachinedeployments.infrastructure.giantswarm.io 126 // apiversion: v1alpha2 127 // release: Since 18.2.0 128 // 129 // documentation: 130 // 131 // This annotation is used to set the size of the logging volume in the nodes. The default is 15 (Gb). 132 const AWSLoggingVolumeSize = "alpha.aws.giantswarm.io/logging-volume-size" 133 134 // support: 135 // - crd: awscontrolplanes.infrastructure.giantswarm.io 136 // apiversion: v1alpha2 137 // release: Since 18.2.0 138 // - crd: awsmachinedeployments.infrastructure.giantswarm.io 139 // apiversion: v1alpha2 140 // release: Since 18.2.0 141 // 142 // documentation: 143 // 144 // This annotation is used to set the size of the docker volume in the nodes. The default is value will be dockerVolumeSizeGB set in the CR. 145 const AWSContainerdVolumeSize = "alpha.aws.giantswarm.io/containerd-volume-size"