Open jcrowthe opened 4 months ago
Hi @jcrowthe ! Thank you for bringing this issue to our attention. The seems to be an issue with the rendering of our documentation, which incorrectly shows encryptionConfig
as a map when it should be represented as an array.
The eks-controller types and CRDs definition correctly defines encryptionConfig
as an array field, which aligns with the AWS EKS API specification
Describe the bug The
Cluster
spec incorrectly labels some properties as maps when they should be arrays. This is in both the CRD definition itself and the documentation here: https://aws-controllers-k8s.github.io/community/reference/eks/v1alpha1/cluster/Steps to reproduce Write the YAML for an EKS
Cluster
object by first copying the documentation https://aws-controllers-k8s.github.io/community/reference/eks/v1alpha1/cluster/ and then filling in all the fields appropriately. When attempting to then apply that custom resource, you will get the following error:The spec listed in the documentation (which is the same as when running
kubectl get crd clusters.eks.services.k8s.aws -oyaml
) is the following (snipped for brevity)However, the following example is actually accepted, and allows for a proper Cluster creation.
The difference is that objects are listed as what is expected, but then arrays are required instead when you actually apply the yaml for resource creation.
Expected outcome Documentation and CRD definition to accurately reflect what is required.
Environment