Skip to content

Commit 9a25cb4

Browse files
committed
Add documentation
Signed-off-by: cpu1 <[email protected]>
1 parent 3ab02ac commit 9a25cb4

File tree

7 files changed

+56
-22
lines changed

7 files changed

+56
-22
lines changed

Diff for: apis/v1alpha1/ack-generate-metadata.yaml

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
ack_generate_info:
2-
build_date: "2024-08-19T13:01:17Z"
3-
build_hash: c21388119d9be1199723e540ec0104b313584348
2+
build_date: "2024-09-16T10:24:09Z"
3+
build_hash: f8f98563404066ac3340db0a049d2e530e5c51cc
44
go_version: go1.22.5
5-
version: v0.35.0-11-gc213881
6-
api_directory_checksum: 469d3f51c38105857920321bcef57f3ff3e5d072
5+
version: v0.38.1
6+
api_directory_checksum: b055cc57ac2cc8b07e374803c280b65d1a72f3bf
77
api_version: v1alpha1
88
aws_sdk_go_version: v1.49.0
99
generator_config_info:

Diff for: apis/v1alpha1/certificate.go

+10-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: config/crd/bases/acm.services.k8s.aws_certificates.yaml

+7-4
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,8 @@ spec:
4141
properties:
4242
certificate:
4343
description: |-
44-
SecretKeyReference combines a k8s corev1.SecretReference with a
45-
specific key within the referred-to Secret
44+
The Certificate to import into AWS Certificate Manager (ACM) to use with services that are integrated with ACM.
45+
This field is only valid when importing an existing certificate into ACM.
4646
properties:
4747
key:
4848
description: Key is the key within the secret
@@ -60,6 +60,9 @@ spec:
6060
type: object
6161
x-kubernetes-map-type: atomic
6262
certificateARN:
63+
description: |-
64+
The Amazon Resource Name (ARN) of an imported certificate to replace. This field is only valid when importing
65+
an existing certificate into ACM.
6366
type: string
6467
certificateAuthorityARN:
6568
description: |-
@@ -168,8 +171,8 @@ spec:
168171
type: object
169172
privateKey:
170173
description: |-
171-
SecretKeyReference combines a k8s corev1.SecretReference with a
172-
specific key within the referred-to Secret
174+
The private key that matches the public key in the certificate. This field is only valid when importing
175+
an existing certificate into ACM.
173176
properties:
174177
key:
175178
description: Key is the key within the secret

Diff for: documentation.yaml

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
resources:
2+
Certificate:
3+
fields:
4+
Certificate:
5+
prepend: |
6+
The Certificate to import into AWS Certificate Manager (ACM) to use with services that are integrated with ACM.
7+
This field is only valid when importing an existing certificate into ACM.
8+
PrivateKey:
9+
prepend: |
10+
The private key that matches the public key in the certificate. This field is only valid when importing
11+
an existing certificate into ACM.
12+
CertificateARN:
13+
prepend: |
14+
The Amazon Resource Name (ARN) of an imported certificate to replace. This field is only valid when importing
15+
an existing certificate into ACM.

Diff for: helm/crds/acm.services.k8s.aws_certificates.yaml

+7-4
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,8 @@ spec:
4141
properties:
4242
certificate:
4343
description: |-
44-
SecretKeyReference combines a k8s corev1.SecretReference with a
45-
specific key within the referred-to Secret
44+
The Certificate to import into AWS Certificate Manager (ACM) to use with services that are integrated with ACM.
45+
This field is only valid when importing an existing certificate into ACM.
4646
properties:
4747
key:
4848
description: Key is the key within the secret
@@ -60,6 +60,9 @@ spec:
6060
type: object
6161
x-kubernetes-map-type: atomic
6262
certificateARN:
63+
description: |-
64+
The Amazon Resource Name (ARN) of an imported certificate to replace. This field is only valid when importing
65+
an existing certificate into ACM.
6366
type: string
6467
certificateAuthorityARN:
6568
description: |-
@@ -168,8 +171,8 @@ spec:
168171
type: object
169172
privateKey:
170173
description: |-
171-
SecretKeyReference combines a k8s corev1.SecretReference with a
172-
specific key within the referred-to Secret
174+
The private key that matches the public key in the certificate. This field is only valid when importing
175+
an existing certificate into ACM.
173176
properties:
174177
key:
175178
description: Key is the key within the secret

Diff for: helm/values.yaml

+5-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
image:
66
repository: public.ecr.aws/aws-controllers-k8s/acm-controller
7-
tag: 0.0.18
7+
tag: 0.0.19
88
pullPolicy: IfNotPresent
99
pullSecrets: []
1010

@@ -158,4 +158,7 @@ leaderElection:
158158
# can be individually enabled ("true") or disabled ("false") by adding key/value
159159
# pairs below.
160160
featureGates:
161-
CARMv2: false
161+
# Enables the Service level granularity for CARM. See https://github.com/aws-controllers-k8s/community/issues/2031
162+
ServiceLevelCARM: false
163+
# Enables the Team level granularity for CARM. See https://github.com/aws-controllers-k8s/community/issues/2031
164+
TeamLevelCARM: false

Diff for: pkg/resource/certificate/references.go

+8-5
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)