Skip to content

Commit 4ec4916

Browse files
committed
docs: discourage Origin CA Keys
Update the authentication documentation to discourage Origin CA Keys in favor of scoped API Tokens. This also updates links to Cloudflare Docs rather than deep linking into the Dashboard.
1 parent 9f468f3 commit 4ec4916

File tree

4 files changed

+7
-5
lines changed

4 files changed

+7
-5
lines changed

README.org

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ pod/origin-ca-issuer-1234568-abcdw 1/1 Running 0 1m
3939

4040
*** Adding an OriginIssuer
4141
**** API Token
42-
Origin CA Issuer can use an [[https://dash.cloudflare.com/profile/api-tokens][API Token]] that contains the "SSL and Certificates" permission, which can be scoped to specific accounts or zones.
42+
Origin CA Issuer can use an API token that contains the "Zone / SSL and Certificates / Edit" permission, which can be scoped to specific accounts or zones. Both [[https://developers.cloudflare.com/fundamentals/api/get-started/create-token/][user API tokens]] and [[https://developers.cloudflare.com/fundamentals/api/get-started/account-owned-tokens/][Account owned tokens]] are supported.
4343

4444
#+BEGIN_SRC sh :file ./deploy/example/cfapi-token.secret.yaml :results silent file :exports code
4545
kubectl create secret generic \
@@ -86,7 +86,7 @@ $ kubectl get originissuer.cert-manager.k8s.cloudflare.com prod-issuer -o json |
8686
#+END_EXAMPLE
8787

8888
**** Origin CA Service Key
89-
Alternatively, the "Origin CA Key" can be used, also found on the API Tokens page. This key will begin with "v1.0-" and is different from the "Global API Key".
89+
The [[https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/][Origin CA Key]] is supported but discouraged in favor of API tokens. This key will begin with "v1.0-" and is different from the legacy "Global API Key".
9090

9191
#+BEGIN_SRC sh :file ./deploy/example/service-key.secret.yaml :results silent file :exports code
9292
kubectl create secret generic \

deploy/crds/cert-manager.k8s.cloudflare.com_clusteroriginissuers.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,8 @@ spec:
4747
API.
4848
properties:
4949
serviceKeyRef:
50-
description: ServiceKeyRef authenticates with an API Service Key.
50+
description: ServiceKeyRef authenticates with an API Service Key
51+
(the "Origin CA Key").
5152
properties:
5253
key:
5354
description: Key of the secret to select from. Must be a valid

deploy/crds/cert-manager.k8s.cloudflare.com_originissuers.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,8 @@ spec:
4747
API.
4848
properties:
4949
serviceKeyRef:
50-
description: ServiceKeyRef authenticates with an API Service Key.
50+
description: ServiceKeyRef authenticates with an API Service Key
51+
(the "Origin CA Key").
5152
properties:
5253
key:
5354
description: Key of the secret to select from. Must be a valid

pkgs/apis/v1/types_originissuer.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ type OriginIssuerStatus struct {
8282
// OriginIssuerAuthentication defines how to authenticate with the Cloudflare API.
8383
// Only one of `serviceKeyRef` may be specified.
8484
type OriginIssuerAuthentication struct {
85-
// ServiceKeyRef authenticates with an API Service Key.
85+
// ServiceKeyRef authenticates with an API Service Key (the "Origin CA Key").
8686
// +optional
8787
ServiceKeyRef *SecretKeySelector `json:"serviceKeyRef,omitempty"`
8888

0 commit comments

Comments
 (0)