APIリファレンス
様々なカスタムリソース定義を含む、cert-manager API ドキュメント。
パッケージ
- acme.cert-manager.io/v1
- cainjector.config.cert-manager.io/v1alpha1
- cert-manager.io/v1
- controller.config.cert-manager.io/v1alpha1
- meta.cert-manager.io/v1
- webhook.config.cert-manager.io/v1alpha1
acme.cert-manager.io/v1
パッケージ v1 は API の v1 バージョンです。
リソースタイプ
チャレンジ
Challenge は、ACME サーバーとのチャレンジリクエストを表すタイプです。
フィールド | 説明 | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersion 文字列 | acme.cert-manager.io/v1 | ||||||||||||||||||
kind 文字列 | チャレンジ | ||||||||||||||||||
metadata Kubernetes meta/v1.ObjectMeta |
| ||||||||||||||||||
spec ChallengeSpec |
| ||||||||||||||||||
status ChallengeStatus | (オプション) |
オーダー
OrderはACMEサーバーとのOrderを表す型です。
フィールド | 説明 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersion 文字列 | acme.cert-manager.io/v1 | ||||||||||||
kind 文字列 | オーダー | ||||||||||||
metadata Kubernetes meta/v1.ObjectMeta |
| ||||||||||||
spec OrderSpec |
| ||||||||||||
status OrderStatus | (オプション) |
ACMEAuthorization
(表示場所: OrderStatus)
ACMEAuthorizationには、ACME OrderリソースのDNS名を検証するために完了する必要がある承認に関する、ACMEサーバーから返されたデータが含まれています。
フィールド | 説明 |
---|---|
url 文字列 | URLは、完了する必要がある承認のURLです。 |
identifier 文字列 | (オプション) Identifierはこの承認の一部として検証されるDNS名です。 |
wildcard bool | (オプション) この承認がワイルドカードDNS名を対象とする場合、Wildcardはtrueになります。これがtrueの場合、識別子はDNS名のワイルドカードではないバージョンになります。例えば、「*.example.com」が検証されているDNS名の場合、このフィールドは「true」になり、「identifier」フィールドは「example.com」になります。 |
initialState State | (オプション) InitialStateは、ACMEサーバーから最初にフェッチされたときのACME承認の初期状態です。承認が既に「有効」になっている場合、Orderコントローラーは承認に対してチャレンジリソースを作成しません。これは、「authz reuse」を有効にするACMEサーバー(Let's Encryptのプロダクションエンドポイントなど)を使用している場合に発生します。設定されておらず、「identifier」が設定されている場合、状態は保留中と見なされ、チャレンジが作成されます。 |
challenges []ACMEChallenge | (オプション) Challengesは、ACMEサーバーによって提供されるチャレンジの種類を指定します。DNS名を検証する際にこれらのチャレンジの種類の1つが選択され、適切なChallengeリソースが作成されてACMEチャレンジプロセスが実行されます。 |
ACMEChallenge
(表示場所: ACMEAuthorization)
Challengeは、Orderに対してACMEサーバーによって提供されるチャレンジを指定します。適切なChallengeリソースを作成して、ACMEチャレンジプロセスを実行できます。
フィールド | 説明 |
---|---|
url 文字列 | URLはこのチャレンジのURLです。ACMEサーバーからチャレンジに関する追加のメタデータを取得するために使用できます。 |
token 文字列 | Tokenはこのチャレンジで提示する必要があるトークンです。これは、提示する必要がある「key」を計算するために使用されます。 |
type 文字列 | Typeは、提供されているチャレンジの種類です(例:「http-01」、「dns-01」、「tls-sni-01」など)。これはACMEサーバーから取得された生の値です。「http-01」と「dns-01」だけがcert-managerでサポートされており、他の値は無視されます。 |
ACMEChallengeSolver
(表示場所: ACMEIssuer, ChallengeSpec)
ACMEChallengeSolverは、それが属するIssuerのACMEチャレンジを解決する方法を記述します。セレクターを提供して、異なるDNS名に対して異なる解決戦略を使用することができます。HTTP01またはDNS01のいずれか1つのみを指定する必要があります。
フィールド | 説明 |
---|---|
selector CertificateDNSNameSelector | (オプション) Selectorは、このチャレンジソルバーを使用して解決する必要があるCertificateリソースのDNSNamesのセットを選択します。指定されていない場合、ソルバーは優先順位が最も低い「デフォルト」ソルバーとして扱われます。つまり、他のソルバーがより具体的な一致を持つ場合、代わりにそれが使用されます。 |
http01 ACMEChallengeSolverHTTP01 | (オプション) HTTP01チャレンジフローを実行することで承認を完了しようとcert-managerを構成します。ワイルドカードドメイン名(例:`*.example.com`)の証明書は、HTTP01チャレンジメカニズムを使用して取得することはできません。 |
dns01 ACMEChallengeSolverDNS01 | (オプション) DNS01チャレンジフローを実行することで承認を完了しようとcert-managerを構成します。 |
ACMEChallengeSolverDNS01
(表示場所: ACMEChallengeSolver)
DNS01チャレンジを解決する際に使用するDNS01チャレンジプロバイダーを構成するために使用します。ソルバーごとに1つのDNSプロバイダーのみを構成できます。
フィールド | 説明 |
---|---|
cnameStrategy CNAMEStrategy | (オプション) CNAMEStrategyは、DNSゾーンでCNAMEレコードが見つかった場合のDNS01プロバイダーの処理方法を構成します。 |
akamai ACMEIssuerDNS01ProviderAkamai | (オプション) Akamai DNSゾーン管理APIを使用してDNS01チャレンジレコードを管理します。 |
cloudDNS ACMEIssuerDNS01ProviderCloudDNS | (オプション) Google Cloud DNS APIを使用してDNS01チャレンジレコードを管理します。 |
cloudflare ACMEIssuerDNS01ProviderCloudflare | (オプション) Cloudflare APIを使用してDNS01チャレンジレコードを管理します。 |
route53 ACMEIssuerDNS01ProviderRoute53 | (オプション) AWS Route53 APIを使用してDNS01チャレンジレコードを管理します。 |
azureDNS ACMEIssuerDNS01ProviderAzureDNS | (オプション) Microsoft Azure DNS APIを使用してDNS01チャレンジレコードを管理します。 |
digitalocean ACMEIssuerDNS01ProviderDigitalOcean | (オプション) DigitalOcean DNS APIを使用してDNS01チャレンジレコードを管理します。 |
acmeDNS ACMEIssuerDNS01ProviderAcmeDNS | (オプション) 「ACME DNS」(https://github.com/joohoi/acme-dns) APIを使用してDNS01チャレンジレコードを管理します。 |
rfc2136 ACMEIssuerDNS01ProviderRFC2136 | (オプション) RFC2136(「ドメインネームシステムの動的更新」)(https://datatracker.ietf.org/doc/rfc2136/)を使用してDNS01チャレンジレコードを管理します。 |
webhook ACMEIssuerDNS01ProviderWebhook | (オプション) 外部WebhookベースのDNS01チャレンジソルバーを構成してDNS01チャレンジレコードを管理します。 |
ACMEChallengeSolverHTTP01
(表示場所: ACMEChallengeSolver)
ACMEChallengeSolverHTTP01には、Kubernetesクラスタ内でHTTP01チャレンジを解決する方法の詳細を記述した構成が含まれています。通常、これは何らかの説明の「ルート」を作成することで実現され、イングレスコントローラーはACMEサーバーのHTTP要求に応答する責任を負う「ソルバーポッド」へのトラフィックを転送するように構成されます。Ingress / Gatewayのいずれか1つのみを指定できます。
フィールド | 説明 |
---|---|
ingress ACMEChallengeSolverHTTP01Ingress | (オプション) イングレスベースのHTTP01チャレンジソルバーは、`/.well-known/acme-challenge/XYZ` のリクエストを、完了する必要がある各チャレンジのためにcert-managerによってプロビジョニングされた「チャレンジソルバー」ポッドにルーティングするために、Ingressリソースの作成または変更によってチャレンジを解決します。 |
gatewayHTTPRoute ACMEChallengeSolverHTTP01GatewayHTTPRoute | (オプション) Gateway APIは、Kubernetesにおけるサービスネットワーキングをモデル化するsig-networkコミュニティAPIです(https://gateway-api.sigs.k8s.io/)。Gatewayソルバーは、チャレンジと同じ名前空間に指定されたラベルを持つHTTPRouteを作成します。このソルバーは実験的であり、将来フィールド/動作が変更される可能性があります。 |
ACMEChallengeSolverHTTP01GatewayHTTPRoute
(表示場所: ACMEChallengeSolverHTTP01)
ACMEChallengeSolverHTTP01GatewayHTTPRouteソルバーは、ACMEチャレンジソルバーポッドにルーティングするGatewayクラスのHTTPRouteオブジェクトを作成します。
フィールド | 説明 |
---|---|
serviceType Kubernetes core/v1.ServiceType | (オプション) Kubernetesソルバーサービスのオプションのサービスの種類です。サポートされている値はNodePortまたはClusterIPです。設定されていない場合、NodePortがデフォルトになります。 |
labels map[string]string | (オプション) HTTP-01チャレンジを解決する際にcert-managerによって作成されるHTTPRouteに適用されるカスタムラベルです。 |
parentRefs []sigs.k8s.io/gateway-api/apis/v1.ParentReference | HTTP-01チャレンジを解決する際、cert-managerはHTTPRouteを作成します。cert-managerは、HTTPRouteを作成する際に使用するparentRefを知る必要があります。通常、parentRefはGatewayを参照します。参照: https://gateway-api.sigs.k8s.io/api-types/httproute/#attaching-to-gateways |
podTemplate ACMEChallengeSolverHTTP01IngressPodTemplate | (オプション) HTTP01チャレンジに使用されるACMEチャレンジソルバーポッドを構成するために使用されるオプションのポッドテンプレートです。 |
ACMEChallengeSolverHTTP01Ingress
(表示場所: ACMEChallengeSolverHTTP01)
フィールド | 説明 |
---|---|
serviceType Kubernetes core/v1.ServiceType | (オプション) Kubernetesソルバーサービスのオプションのサービスの種類です。サポートされている値はNodePortまたはClusterIPです。設定されていない場合、NodePortがデフォルトになります。 |
ingressClassName 文字列 | (オプション) このフィールドは、このチャレンジソルバーを使用するACMEチャレンジを解決するために使用される作成されたIngressリソースのフィールド`ingressClassName`を構成します。これは、イングレスクラスを構成するための推奨方法です。`class`、`name`、`ingressClassName`のいずれか1つのみを指定できます。 |
class 文字列 | (オプション) このフィールドは、このチャレンジソルバーを使用するACMEチャレンジを解決するためにIngressリソースを作成する際の注釈`kubernetes.io/ingress.class`を構成します。`class`、`name`、`ingressClassName`のいずれか1つのみを指定できます。 |
name 文字列 | (オプション) HTTP01チャレンジを解決するために、ACMEチャレンジ解決ルートを挿入する必要があるIngressリソースの名前。これは通常、外部IPとIngressリソース間の1対1のマッピングを維持するingress-gceなどのIngressコントローラーと組み合わせて使用されます。 |
podTemplate ACMEChallengeSolverHTTP01IngressPodTemplate | (オプション) HTTP01チャレンジに使用されるACMEチャレンジソルバーポッドを構成するために使用されるオプションのポッドテンプレートです。 |
ingressTemplate ACMEChallengeSolverHTTP01IngressTemplate | (オプション) HTTP01チャレンジに使用されるACMEチャレンジソルバーIngressの設定に使用されるオプションのIngressテンプレート。 |
ACMEChallengeSolverHTTP01IngressObjectMeta
(表示場所: ACMEChallengeSolverHTTP01IngressTemplate)
フィールド | 説明 |
---|---|
annotations map[string]string | (オプション) 作成されたACME HTTP01ソルバーIngressに追加するアノテーション。 |
labels map[string]string | (オプション) 作成されたACME HTTP01ソルバーIngressに追加するラベル。 |
ACMEChallengeSolverHTTP01IngressPodObjectMeta
(表示場所: ACMEChallengeSolverHTTP01IngressPodTemplate)
フィールド | 説明 |
---|---|
annotations map[string]string | (オプション) 作成されたACME HTTP01ソルバーPodに追加するアノテーション。 |
labels map[string]string | (オプション) 作成されたACME HTTP01ソルバーPodに追加するラベル。 |
ACMEChallengeSolverHTTP01IngressPodSecurityContext
(表示場所: ACMEChallengeSolverHTTP01IngressPodSpec)
フィールド | 説明 |
---|---|
seLinuxOptions Kubernetes core/v1.SELinuxOptions | (オプション) すべてのコンテナに適用するSELinuxコンテキスト。指定しない場合、コンテナランタイムは各コンテナにランダムなSELinuxコンテキストを割り当てます。SecurityContextにも設定できます。SecurityContextとPodSecurityContextの両方に設定されている場合、SecurityContextで指定された値がそのコンテナに対して優先されます。spec.os.nameがwindowsの場合、このフィールドは設定できません。 |
runAsUser int64 | (オプション) コンテナプロセスのエントリポイントを実行するUID。指定しない場合、イメージメタデータで指定されたユーザーがデフォルトになります。SecurityContextにも設定できます。SecurityContextとPodSecurityContextの両方に設定されている場合、SecurityContextで指定された値がそのコンテナに対して優先されます。spec.os.nameがwindowsの場合、このフィールドは設定できません。 |
runAsGroup int64 | (オプション) コンテナプロセスのエントリポイントを実行するGID。設定されていない場合は、ランタイムのデフォルトを使用します。SecurityContextにも設定できます。SecurityContextとPodSecurityContextの両方に設定されている場合、SecurityContextで指定された値がそのコンテナに対して優先されます。spec.os.nameがwindowsの場合、このフィールドは設定できません。 |
runAsNonRoot bool | (オプション) コンテナをルート以外のユーザーとして実行する必要があることを示します。trueの場合、Kubeletは実行時にイメージを検証して、UID 0(ルート)として実行されないことを確認し、実行されない場合はコンテナの起動に失敗します。設定されていないかfalseの場合、そのような検証は実行されません。SecurityContextにも設定できます。SecurityContextとPodSecurityContextの両方に設定されている場合、SecurityContextで指定された値が優先されます。 |
supplementalGroups []int64 | (オプション) コンテナのプライマリGID、fsGroup(指定されている場合)、およびコンテナプロセスのuidのコンテナイメージで定義されたグループメンバーシップに加えて、各コンテナで最初に実行されるプロセスに適用されるグループのリスト。指定されていない場合、追加のグループはどのコンテナにも追加されません。コンテナプロセスのuidのコンテナイメージで定義されたグループメンバーシップは、このリストに含まれていなくても有効であることに注意してください。spec.os.nameがwindowsの場合、このフィールドは設定できません。 |
fsGroup int64 | (オプション) Pod内のすべてのコンテナに適用される特別な補足グループ。一部のボリュームタイプでは、Kubeletがそのボリュームの所有権をPodが所有するように変更できます。
設定されていない場合、Kubeletはボリュームの所有権とパーミッションを変更しません。spec.os.nameがwindowsの場合、このフィールドは設定できません。 |
sysctls []Kubernetes core/v1.Sysctl | (オプション) Sysctlsは、Podに使用される名前空間付きsysctlsのリストを保持します。サポートされていないsysctls(コンテナランタイムによる)を持つPodは起動に失敗する可能性があります。spec.os.nameがwindowsの場合、このフィールドは設定できません。 |
fsGroupChangePolicy Kubernetes core/v1.PodFSGroupChangePolicy | (オプション) fsGroupChangePolicyは、Pod内で公開される前にボリュームの所有権とパーミッションを変更する動作を定義します。このフィールドは、fsGroupベースの所有権(およびパーミッション)をサポートするボリュームタイプにのみ適用されます。secret、configmaps、emptydirなどのephemeralボリュームタイプには影響しません。有効な値は「OnRootMismatch」と「Always」です。指定されていない場合、「Always」が使用されます。spec.os.nameがwindowsの場合、このフィールドは設定できません。 |
seccompProfile Kubernetes core/v1.SeccompProfile | (オプション) このPodのコンテナで使用されるseccompオプション。spec.os.nameがwindowsの場合、このフィールドは設定できません。 |
ACMEChallengeSolverHTTP01IngressPodSpec
(表示場所: ACMEChallengeSolverHTTP01IngressPodTemplate)
フィールド | 説明 |
---|---|
nodeSelector map[string]string | (オプション) NodeSelectorは、Podがノードに適合するためにtrueでなければならないセレクターです。Podがそのノードにスケジュールされるために、ノードのラベルと一致する必要があるセレクター。詳細情報: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ |
affinity Kubernetes core/v1.Affinity | (オプション) 指定されている場合、Podのスケジューリング制約。 |
tolerations []Kubernetes core/v1.Toleration | (オプション) 指定されている場合、Podの許容値。 |
priorityClassName 文字列 | (オプション) 指定されている場合、PodのpriorityClassName。 |
serviceAccountName 文字列 | (オプション) 指定されている場合、Podのサービスアカウント。 |
imagePullSecrets []Kubernetes core/v1.LocalObjectReference | (オプション) 指定されている場合、PodのimagePullSecrets。 |
securityContext ACMEChallengeSolverHTTP01IngressPodSecurityContext | (オプション) 指定されている場合、Podのセキュリティコンテキスト。 |
ACMEChallengeSolverHTTP01IngressPodTemplate
(表示場所: ACMEChallengeSolverHTTP01GatewayHTTPRoute, ACMEChallengeSolverHTTP01Ingress)
フィールド | 説明 | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata ACMEChallengeSolverHTTP01IngressPodObjectMeta | (オプション) HTTP01チャレンジを解決するために使用されるPodのObjectMetaのオーバーライド。'labels'と'annotations'フィールドのみを設定できます。ラベルまたはアノテーションが組み込みの値と重複する場合、ここの値が組み込みの値をオーバーライドします。 | ||||||||||||||
spec ACMEChallengeSolverHTTP01IngressPodSpec | (オプション) PodSpecは、HTTP01チャレンジソルバーPodのオーバーライドを定義します。現在サポートされているフィールドについては、ACMEChallengeSolverHTTP01IngressPodSpecを確認してください。その他のすべてのフィールドは無視されます。
|
ACMEChallengeSolverHTTP01IngressTemplate
(表示場所: ACMEChallengeSolverHTTP01Ingress)
フィールド | 説明 |
---|---|
metadata ACMEChallengeSolverHTTP01IngressObjectMeta | (オプション) HTTP01チャレンジを解決するために使用されるIngressのObjectMetaのオーバーライド。'labels'と'annotations'フィールドのみを設定できます。ラベルまたはアノテーションが組み込みの値と重複する場合、ここの値が組み込みの値をオーバーライドします。 |
ACMEChallengeType (string
別名)
(表示場所: ChallengeSpec)
ACMEチャレンジのタイプ。HTTP-01とDNS-01のみがサポートされています。
値 | 説明 |
---|---|
"DNS-01" | ACMEChallengeTypeDNS01は、チャレンジがdns-01タイプであることを示します。詳細情報: https://letsencrypt.dokyumento.jp/docs/challenge-types/#dns-01-challenge |
"HTTP-01" | ACMEChallengeTypeHTTP01は、チャレンジがhttp-01タイプであることを示します。詳細情報: https://letsencrypt.dokyumento.jp/docs/challenge-types/#http-01-challenge |
ACMEExternalAccountBinding
(表示場所: ACMEIssuer)
ACMEExternalAccountBindingは、ACMEサーバーのCA外部アカウントへの参照です。
フィールド | 説明 |
---|---|
keyID 文字列 | keyIDは、外部アカウントがバインドされているCAキーのIDです。 |
keySecretRef SecretKeySelector | keySecretRefは、外部アカウントバインディングの対称MACキーを保持するKubernetes Secret内のデータアイテムを参照するSecret Key Selectorです。 |
keyAlgorithm HMACKeyAlgorithm | (オプション) 非推奨: keyAlgorithmフィールドは、過去の互換性のために存在しており、使用しないでください。アルゴリズムは現在、golang/x/crypto/acmeでHS256にハードコーディングされています。 |
ACMEIssuer
(表示場所: IssuerConfig)
ACMEIssuerには、ACME発行者の仕様が含まれています。これはRFC8555仕様を使用して、「チャレンジ」を完了することによりドメイン識別子の所有権を証明することで証明書を取得します。以前のドラフトバージョンのACME仕様はサポートされていません。
フィールド | 説明 |
---|---|
email 文字列 | (オプション) Emailは、ACMEアカウントに関連付けるメールアドレスです。このフィールドはオプションですが、設定することを強くお勧めします。アカウントまたは証明書の問題(有効期限の通知メールを含む)が発生した場合に、連絡を取るために使用されます。このフィールドは、アカウントが最初に登録された後に更新できます。 |
server 文字列 | Serverは、ACMEサーバーの「ディレクトリ」エンドポイントにアクセスするために使用されるURLです。たとえば、Let's Encryptのステージングエンドポイントの場合、「https://acme-staging-v02.api.letsencrypt.org/directory」を使用します。ACME v2エンドポイント(つまり、RFC 8555)のみがサポートされています。 |
preferredChain 文字列 | (オプション) PreferredChainは、ACMEサーバーが複数出力した場合に使用するチェーンです。PreferredChainは、これがACMEエンドポイントによって配信されるという保証はありません。たとえば、Let's EncryptのDSTクロスサインの場合、「DST Root CA X3」または新しいLet's EncryptルートCAの場合は「ISRG Root X1」を使用します。この値は、ルートCAとしてこの値を持つ証明書を持つ、ACMEのデフォルトと代替チェーンの組み合わせセットの最初の証明書バンドルを選択します。 |
caBundle []byte | (オプション) ACMEサーバーによって提示された証明書チェーンを検証するために使用できる、PEM CAのBase64エンコードバンドル。SkipTLSVerifyとは相互に排他的です。さまざまな種類のセキュリティ脆弱性を防ぐために、CABundleの使用を優先してください。CABundleとSkipTLSVerifyが設定されていない場合、コンテナ内のシステム証明書バンドルを使用してTLS接続を検証します。 |
skipTLSVerify bool | (オプション) 非推奨:ACMEサーバーのTLS証明書の検証を有効または無効にします。trueの場合、ACMEサーバーへのリクエストではTLS証明書チェーンの検証が行われません。CABundleとは相互に排他的です。さまざまな種類のセキュリティ脆弱性を防ぐために、CABundleの使用を優先してください。開発環境でのみこのオプションを有効にしてください。CABundleとSkipTLSVerifyが設定されていない場合、コンテナ内のシステム証明書バンドルを使用してTLS接続を検証します。デフォルトはfalseです。 |
externalAccountBinding ACMEExternalAccountBinding | (オプション) ExternalAccountBindingは、ACMEサーバーのCA外部アカウントへの参照です。設定されている場合、登録時にcert-managerは、指定された外部アカウント資格情報を登録済みのACMEアカウントに関連付けようとします。 |
privateKeySecretRef SecretKeySelector | PrivateKey は、自動生成された ACME アカウントの秘密鍵を格納するために使用される Kubernetes Secret リソースの名前です。オプションで、 |
ソルバー []ACMEChallengeSolver | (オプション) Solvers は、一致するドメインの ACME チャレンジを解決するために使用されるチャレンジソルバーのリストです。ACME サーバーから証明書を取得するには、ソルバーの設定を提供する必要があります。詳細については、以下を参照してください。 https://cert-manager.dokyumento.jp/docs/configuration/acme/ |
disableAccountKeyGeneration bool | (オプション) 新しい ACME アカウントキーの生成を有効または無効にします。true の場合、Issuer リソースは新しいアカウントを要求せず、既存のシークレットを介してアカウントキーが提供されることを期待します。false の場合、cert-manager システムは Issuer に新しい ACME アカウントキーを生成します。デフォルトは false です。 |
enableDurationFeature bool | (オプション) 証明書の有効期間と一致する Not After 日付の証明書を要求することを有効にします。Let's Encrypt など、すべての ACME サーバーでサポートされているわけではありません。ACME サーバーがこれをサポートしていない場合に true に設定すると、Order でエラーが発生します。デフォルトは false です。 |
ACMEIssuerDNS01ProviderAcmeDNS
(表示場所: ACMEChallengeSolverDNS01)
ACMEIssuerDNS01ProviderAcmeDNS は、ACME-DNS サーバーの設定を含む構造体です。
フィールド | 説明 |
---|---|
ホスト 文字列 | |
accountSecretRef SecretKeySelector |
ACMEIssuerDNS01ProviderAkamai
(表示場所: ACMEChallengeSolverDNS01)
ACMEIssuerDNS01ProviderAkamai は、Akamai DNS(ゾーンレコード管理 API)の DNS 設定を含む構造体です。
フィールド | 説明 |
---|---|
serviceConsumerDomain 文字列 | |
clientTokenSecretRef SecretKeySelector | |
clientSecretSecretRef SecretKeySelector | |
accessTokenSecretRef SecretKeySelector |
ACMEIssuerDNS01ProviderAzureDNS
(表示場所: ACMEChallengeSolverDNS01)
ACMEIssuerDNS01ProviderAzureDNS は、Azure DNS の設定を含む構造体です。
フィールド | 説明 |
---|---|
clientID 文字列 | (オプション) 認証: Azure Service Principal: Azure DNS での認証に使用される Azure Service Principal の ClientID。設定する場合は、ClientSecret と TenantID も設定する必要があります。 |
clientSecretSecretRef SecretKeySelector | (オプション) 認証: Azure Service Principal: Service Principal に関連付けられたパスワードを含む Secret への参照。設定する場合は、ClientID と TenantID も設定する必要があります。 |
subscriptionID 文字列 | Azure サブスクリプションの ID |
tenantID 文字列 | (オプション) 認証: Azure Service Principal: Azure DNS での認証に使用される Azure Service Principal の TenantID。設定する場合は、ClientID と ClientSecret も設定する必要があります。 |
resourceGroupName 文字列 | DNS ゾーンが存在するリソースグループ |
hostedZoneName 文字列 | (オプション) 使用する DNS ゾーンの名前 |
環境 AzureDNSEnvironment | (オプション) Azure 環境の名前 (デフォルトは AzurePublicCloud) |
managedIdentity AzureManagedIdentity | (オプション) 認証: Azure Workload Identity または Azure Managed Service Identity: Azure Workload Identity または Azure Managed Service Identity を有効にする設定。設定する場合は、ClientID、ClientSecret、および TenantID を設定しないでください。 |
ACMEIssuerDNS01ProviderCloudDNS
(表示場所: ACMEChallengeSolverDNS01)
ACMEIssuerDNS01ProviderCloudDNS は、Google Cloud DNS の DNS 設定を含む構造体です。
フィールド | 説明 |
---|---|
serviceAccountSecretRef SecretKeySelector | (オプション) |
プロジェクト 文字列 | |
hostedZoneName 文字列 | (オプション) HostedZoneName は、チャレンジレコードを作成する必要がある Cloud DNS ゾーンを cert-manager に伝えるオプションフィールドです。空のままにすると、cert-manager は自動的にゾーンを選択します。 |
ACMEIssuerDNS01ProviderCloudflare
(表示場所: ACMEChallengeSolverDNS01)
ACMEIssuerDNS01ProviderCloudflare は、Cloudflare の DNS 設定を含む構造体です。apiKeySecretRef
または apiTokenSecretRef
のいずれかを指定する必要があります。
フィールド | 説明 |
---|---|
email 文字列 | (オプション) アカウントのメールアドレス。API キーベースの認証を使用する場合にのみ必要です。 |
apiKeySecretRef SecretKeySelector | (オプション) Cloudflare での認証に使用する API キー。注: 権限の制御を強化するために、API トークンを使用した認証が推奨される方法となっています。 |
apiTokenSecretRef SecretKeySelector | (オプション) Cloudflare での認証に使用される API トークン。 |
ACMEIssuerDNS01ProviderDigitalOcean
(表示場所: ACMEChallengeSolverDNS01)
ACMEIssuerDNS01ProviderDigitalOcean は、DigitalOcean Domains の DNS 設定を含む構造体です。
フィールド | 説明 |
---|---|
tokenSecretRef SecretKeySelector |
ACMEIssuerDNS01ProviderRFC2136
(表示場所: ACMEChallengeSolverDNS01)
ACMEIssuerDNS01ProviderRFC2136 は、RFC2136 DNS の設定を含む構造体です。
フィールド | 説明 |
---|---|
ネームサーバー 文字列 | RFC2136 をサポートする権限のある DNS サーバーの IP アドレスまたはホスト名(host:port の形式)。ホストが IPv6 アドレスの場合は、角括弧で囲む必要があります(例: [2001:db8::1])。ポートはオプションです。このフィールドは必須です。 |
tsigSecretSecretRef SecretKeySelector | (オプション) TSIG 値を含むシークレットの名前。 |
tsigKeyName 文字列 | (オプション) DNS に設定されている TSIG キー名。 |
tsigAlgorithm 文字列 | (オプション) RFC2136 をサポートする DNS に設定されている TSIG アルゴリズム。 |
ACMEIssuerDNS01ProviderRoute53
(表示場所: ACMEChallengeSolverDNS01)
ACMEIssuerDNS01ProviderRoute53 は、AWS の Route 53 設定を含む構造体です。
フィールド | 説明 |
---|---|
auth Route53Auth | (オプション) Auth は、cert-manager がどのように認証するかを設定します。 |
accessKeyID 文字列 | (オプション) AccessKeyID は認証に使用されます。SecretAccessKeyID が設定されている場合は設定できません。アクセスキーとキーIDのどちらも設定されていない場合、環境変数、共有資格情報ファイル、または AWS インスタンスメタデータを使用します。詳細については、以下を参照してください。 https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials |
accessKeyIDSecretRef SecretKeySelector | (オプション) SecretAccessKey は認証に使用されます。設定する場合は、Kubernetes Secret 内のキーから AWS アクセスキー ID を取得します。AccessKeyID が設定されている場合は設定できません。アクセスキーとキーIDのどちらも設定されていない場合、環境変数、共有資格情報ファイル、または AWS インスタンスメタデータを使用します。詳細については、以下を参照してください。 https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials |
secretAccessKeySecretRef SecretKeySelector | (オプション) SecretAccessKey は認証に使用されます。アクセスキーとキーIDのどちらも設定されていない場合、環境変数、共有資格情報ファイル、または AWS インスタンスメタデータを使用します。詳細については、以下を参照してください。 https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials |
ロール 文字列 | (オプション) Role は、Route53 プロバイダーが明示的な資格情報 AccessKeyID/SecretAccessKey または環境変数、共有資格情報ファイル、または AWS インスタンスメタデータから推論された資格情報を使用して想定するロール ARN です。 |
hostedZoneID 文字列 | (オプション) 設定されている場合、プロバイダーは Route53 のこのゾーンのみを管理し、route53:ListHostedZonesByName API 呼び出しを使用してルックアップを実行しません。 |
リージョン 文字列 | (オプション) AWS リージョンを上書きします。 Route53 はグローバルサービスであり、リージョンエンドポイントはありませんが、ここで指定されたリージョン(または環境変数経由)は、Route53 に接続するときの正しい AWS 資格スコープとパーティションの計算に役立つヒントとして使用されます。以下を参照してください。- Amazon Route 53 エンドポイントとクォータ- グローバルサービス このリージョンフィールドを省略した場合、cert-manager は設定されている場合、AWS_REGION および AWS_DEFAULT_REGION 環境変数からリージョンを使用します。 IAM Roles for Service Accounts (IRSA) を使用する場合、 EKS Pod Identities を使用する場合、 |
ACMEIssuerDNS01ProviderWebhook
(表示場所: ACMEChallengeSolverDNS01)
ACMEIssuerDNS01ProviderWebhook は、Webhook DNS01 プロバイダーの設定を指定し、ChallengePayload リソースを POST する場所を含みます。
フィールド | 説明 |
---|---|
groupName 文字列 | ChallengePayload リソースを webhook apiserver に POST する際に使用する API グループ名。これは、webhook プロバイダーの実装で指定された GroupName と同じである必要があります。 |
solverName 文字列 | webhook プロバイダーの実装で定義されている、使用するソルバーの名前。通常はプロバイダーの名前(例: 'cloudflare')になります。 |
config Kubernetes apiextensions/v1.JSON | (オプション) チャレンジが処理される際に webhook apiserver に渡す追加の設定。任意の JSON データを含めることができます。シークレット値はこの節で指定しないでください。シークレット値が必要な場合(例:DNS サービスの資格情報)、SecretKeySelector を使用して Secret リソースを参照する必要があります。このフィールドのスキーマの詳細については、webhook プロバイダーの実装のドキュメントを参照してください。 |
ACMEIssuerStatus
(表示場所: IssuerStatus)
フィールド | 説明 |
---|---|
uri 文字列 | (オプション) URI は一意のアカウント識別子であり、CA からアカウントの詳細を取得するためにも使用できます。 |
lastRegisteredEmail 文字列 | (オプション) LastRegisteredEmail は、最新の登録済み ACME アカウントに関連付けられたメールアドレスです。Issuer に関連付けられた登録済みアカウントに加えられた変更を追跡するために使用されます。 |
lastPrivateKeyHash 文字列 | (オプション) LastPrivateKeyHash は、最新の登録済み ACME アカウントに関連付けられた秘密鍵のハッシュです。Issuer に関連付けられた登録済みアカウントに加えられた変更を追跡するために使用されます。 |
AzureDNSEnvironment (string
別名)
(表示場所: ACMEIssuerDNS01ProviderAzureDNS)
値 | 説明 |
---|---|
"AzureChinaCloud" | |
"AzureGermanCloud" | |
"AzurePublicCloud" | |
"AzureUSGovernmentCloud" |
AzureManagedIdentity
(表示場所: ACMEIssuerDNS01ProviderAzureDNS)
AzureManagedIdentity は、Azure Workload Identity または Azure Managed Service Identity の設定を含みます。AZURE_FEDERATED_TOKEN_FILE 環境変数が設定されている場合、Azure Workload Identity が使用されます。それ以外の場合は、Azure Managed Service Identity を使用します。
フィールド | 説明 |
---|---|
clientID 文字列 | (オプション) マネージド ID のクライアント ID。resourceID と同時に使用することはできません。 |
resourceID 文字列 | (オプション) マネージド ID のリソース ID。clientID と同時に使用することはできません。Azure Managed Service Identity では使用できません。 |
CNAMEStrategy (string
別名)
(表示場所: ACMEChallengeSolverDNS01)
CNAMEStrategy は、DNS ゾーン内で CNAME レコードが見つかった場合に、DNS01 プロバイダーがどのように CNAME レコードを処理するかを構成します。デフォルトでは、None 戦略が適用されます(つまり、CNAME を追跡しません)。
CertificateDNSNameSelector
(表示場所: ACMEChallengeSolver)
CertificateDNSNameSelector は、ラベルセレクターを使用して証明書を選択し、必要に応じてそれらの証明書内の個々の DNS 名を選択できます。MatchLabels と DNSNames の両方が空の場合、このセレクターはそれらに含まれるすべての証明書と DNS 名に一致します。
フィールド | 説明 |
---|---|
matchLabels map[string]string | (オプション) このチャレンジソルバーが適用される証明書のセットを絞り込むために使用されるラベルセレクターです。 |
dnsNames []string | (オプション) このソルバーが使用される DNS 名のリストです。指定されていて一致が見つかった場合、dnsNames セレクターは dnsZones セレクターよりも優先されます。複数のソルバーが同じ dnsNames 値と一致する場合、matchLabels で最も多くのラベルが一致するソルバーが選択されます。どちらも一致数が同じ場合、リストで先に定義されたソルバーが選択されます。 |
dnsZones []string | (オプション) このソルバーが使用される DNS ゾーンのリストです。ここで指定された最も具体的な DNS ゾーンの一致が、他の DNS ゾーンの一致よりも優先されます。そのため、sys.example.com を指定するソルバーは、example.com を指定するソルバーよりも、ドメイン www.sys.example.com に対して選択されます。複数のソルバーが同じ dnsZones 値と一致する場合、matchLabels で最も多くのラベルが一致するソルバーが選択されます。どちらも一致数が同じ場合、リストで先に定義されたソルバーが選択されます。 |
ChallengeSpec
(表示場所: Challenge)
フィールド | 説明 |
---|---|
url 文字列 | このチャレンジの ACME チャレンジリソースの URL。これを使用して、このチャレンジのステータスの詳細を検索できます。 |
authorizationURL 文字列 | このチャレンジが属するACME承認リソースのURL。 |
dnsName 文字列 | dnsNameはこのチャレンジの対象となる識別子です(例: example.com)。要求されたDNSNameがワイルドカードの場合、このフィールドはワイルドカードではないドメインに設定する必要があります。例えば、`*.example.com`の場合は`example.com`にする必要があります。 |
wildcard bool | (オプション) このチャレンジがワイルドカード識別子(例: `*.example.com`)を対象とする場合、wildcardはtrueになります。 |
type ACMEChallengeType | このリソースが表すACMEチャレンジの種類です。「HTTP-01」または「DNS-01」のいずれかです。 |
token 文字列 | このチャレンジのACMEチャレンジトークンです。これはACMEサーバーから返された生の値です。 |
key 文字列 | このチャレンジのACMEチャレンジキーです。HTTP01チャレンジの場合、これはHTTP01チャレンジを完了するために応答する必要がある値であり、以下の形式になります: `<秘密鍵JWKサムプリント>.<チャレンジのためのacmeサーバーからのキー>`。DNS01チャレンジの場合、これは`<秘密鍵JWKサムプリント>.<チャレンジのためのacmeサーバーからのキー>`テキストのbase64エンコードされたSHA256ハッシュであり、TXTレコードの内容として設定する必要があります。 |
solver ACMEChallengeSolver | このチャレンジリソースを解決するために使用する必要があるドメイン解決構成が含まれています。 |
issuerRef ObjectReference | このチャレンジを作成するために使用する必要がある、正しく構成されたACMEタイプのIssuerを参照します。Issuerが存在しない場合、処理は再試行されます。Issuerが「ACME」Issuerでない場合、エラーが返され、チャレンジは失敗としてマークされます。 |
ChallengeStatus
(表示場所: Challenge)
フィールド | 説明 |
---|---|
processing bool | (オプション) このチャレンジを処理するかどうかを示すために使用されます。このフィールドは、「スケジューリング」コンポーネントによってのみ true に設定されます。「チャレンジ」コントローラーによって、チャレンジが最終状態に達するか、タイムアウトした後にのみ false に設定されます。このフィールドが false に設定されている場合、チャレンジコントローラーはそれ以上アクションを実行しません。 |
presented bool | (オプション) このチャレンジのチャレンジ値が現在「提示」されている場合、presented は true に設定されます。これは、自己チェックがパスしていることを意味するものではありません。値が適切なチャレンジメカニズムに対して「送信」されたことのみを示します(つまり、DNS01 TXT レコードが提示されたか、HTTP01 構成が構成されたことを意味します)。 |
reason 文字列 | (オプション) チャレンジが現在の状態にある理由に関する、人間が読める情報を格納します。 |
state State | (オプション) チャレンジの現在の「状態」を格納します。設定されていない場合、チャレンジの状態は不明です。 |
HMACKeyAlgorithm (string
alias)
(表示場所: ACMEExternalAccountBinding)
HMACKeyAlgorithm は、HMAC 暗号化に使用されるキーアルゴリズムの名前です。
値 | 説明 |
---|---|
"HS256" | |
"HS384" | |
"HS512" |
OrderSpec
(表示場所: Order)
フィールド | 説明 |
---|---|
request []byte | DERエンコーディングの証明書署名要求バイトです。これはオーダーを確定する際に使用されます。このフィールドはオーダーに設定する必要があります。 |
issuerRef ObjectReference | IssuerRefは、このOrderの作成に使用される適切に構成されたACMEタイプのIssuerを参照します。Issuerが存在しない場合、処理は再試行されます。Issuerが「ACME」Issuerでない場合、エラーが返され、Orderは失敗としてマークされます。 |
commonName 文字列 | (オプション) CommonNameは、DERエンコードされたCSRに指定されている共通名です。指定されている場合、この値は`dnsNames`または`ipAddresses`にも存在する必要があります。このフィールドは、DERエンコードされたCSR上の対応するフィールドと一致する必要があります。 |
dnsNames []string | (オプション) DNSNamesは、Order検証プロセスの一部として含める必要があるDNS名のリストです。このフィールドは、DERエンコードされたCSR上の対応するフィールドと一致する必要があります。 |
ipAddresses []string | (オプション) IPAddressesは、Order検証プロセスの一部として含める必要があるIPアドレスのリストです。このフィールドは、DERエンコードされたCSR上の対応するフィールドと一致する必要があります。 |
duration Kubernetes meta/v1.Duration | (オプション) Durationは、要求された証明書のnot after日付の期間です。これはACME仕様に従って、オーダー作成時に設定されます。 |
OrderStatus
(表示場所: Order)
フィールド | 説明 |
---|---|
url 文字列 | (オプション) Order の URL です。これは、リソースが最初に作成されたときは最初は空です。Order コントローラーは、Order が最初に処理されたときにこのフィールドを設定します。このフィールドは、最初に設定された後は変更できません。 |
finalizeURL 文字列 | (オプション) Order の FinalizeURL です。これは、Order が完了したら、この Order の証明書を取得するために使用されます。 |
authorizations []ACMEAuthorization | (オプション) Authorizations には、Order に指定された DNS 名を検証するために完了する必要がある承認に関する、ACME サーバーから返されたデータが含まれています。 |
certificate []byte | (オプション) Certificate は、この Order の PEM エンコードされた証明書のコピーです。このフィールドは、Order が ACME サーバーで正常に完了し、Order が「有効」状態に移行した後に設定されます。 |
state State | (オプション) State には、この Order リソースの現在の状態が含まれています。「success」と「expired」の状態は「最終」状態です。 |
reason 文字列 | (オプション) Reason は、Order が現在の状態にある理由に関する追加情報をオプションで提供します。 |
failureTime Kubernetes meta/v1.Time | (オプション) FailureTime は、この Order が失敗した時間を格納します。これは、ガベージコレクションとバックオフに影響を与えるために使用されます。 |
Route53Auth
(表示場所: ACMEIssuerDNS01ProviderRoute53)
Route53Auth は、Route53 で認証するために使用される構成です。
フィールド | 説明 |
---|---|
kubernetes Route53KubernetesAuth | Kubernetes は、バインドされた ServiceAccount トークンを渡すことで、AssumeRoleWithWebIdentity を使用して Route53 で認証します。 |
Route53KubernetesAuth
(表示場所: Route53Auth)
Route53KubernetesAuth は、バインドされた Kubernetes ServiceAccount トークンを使用して Route53 に対して認証するための構成です。
フィールド | 説明 |
---|---|
serviceAccountRef ServiceAccountRef | バインドされたトークン(「投影されたトークン」とも呼ばれます)を要求するために使用されるサービスアカウントへの参照です。このフィールドを使用するには、cert-manager がトークンを要求できるように RBAC ルールを構成する必要があります。 |
ServiceAccountRef
(表示場所: Route53KubernetesAuth)
ServiceAccountRef は、cert-manager がトークンを要求するために使用するサービスアカウントです。トークンの有効期限も cert-manager によって 10 分に設定されます。
フィールド | 説明 |
---|---|
name 文字列 | トークンを要求するために使用される ServiceAccount の名前です。 |
audiences []string | (オプション) TokenAudiences は、AWS に渡されるトークンに含めるオーディエンスのオプションのリストです。発行者の名前空間と名前からなるデフォルトのトークンは常に含まれます。設定されていない場合、オーディエンスは |
State (string
alias)
(表示場所: ACMEAuthorization, ChallengeStatus, OrderStatus)
State は、Order など、ACME リソースの状態を表します。ここの可能性のあるオプションは、ACME 仕様の対応する値にマップされます。これらの値の詳細については、こちらをご覧ください。https://tools.ietf.org/html/draft-ietf-acme-acme-15#section-7.1.6 このタイプを使用するクライアントは、この列挙の内容が時間の経過とともに追加される可能性があるため、不明な値も適切に処理する必要があります。
値 | 説明 |
---|---|
"errored" | Errored は、何らかの理由で ACME リソースにエラーが発生したことを示します。これは包括的な状態であり、検証の失敗などの内部 cert-manager エラーのマーク付けに使用されます。これは最終状態です。 |
"expired" | Expired は、ACME リソースが期限切れになったことを示します。Order が「Expired」とマークされている場合、その検証の 1 つが期限切れになったか、Order 自体が期限切れになった可能性があります。これは最終状態です。 |
"invalid" | Invalid は、何らかの理由で ACME リソースが無効であることを示します。Order が「invalid」とマークされている場合、その検証の 1 つが何らかの理由で無効である必要があります。これは最終状態です。 |
"pending" | Pending は、ACME リソースがまだ保留中で、まだ準備ができていないことを示します。Order が「Pending」とマークされている場合、その Order の検証はまだ進行中です。これは一時的な状態です。 |
"processing" | Processing は、ACME リソースがサーバーによって処理されていることを示します。Order が「Processing」とマークされている場合、その Order の検証は現在処理中です。これは一時的な状態です。 |
"ready" | Ready は、ACME リソースが準備完了状態にあることを示します。Order が「ready」の場合、そのすべてのチャレンジが正常に完了し、Order は完了する準備ができています。完了すると、「有効」状態に移行します。これは一時的な状態です。 |
"" | Unknown は、ACME 仕様の一部としての実際の状態ではありません。認識されない値を表すために使用されます。 |
"valid" | Valid は、ACME リソースが有効な状態にあることを示します。Order が「valid」の場合、ACME サーバーで完了しており、証明書は Order のステータス サブリソースに格納されている証明書 URL を使用して ACME サーバーから取得できます。これは最終状態です。 |
cainjector.config.cert-manager.io/v1alpha1
パッケージ v1alpha1 は、cainjector 構成 API の v1alpha1 バージョンです。
リソースタイプ
CAInjectorConfiguration
フィールド | 説明 |
---|---|
kubeConfig 文字列 | kubeConfig は、Kubernetes apiserver に接続するために使用される kubeconfig ファイルです。指定されていない場合、cainjector はインクラスター構成の読み込みを試みます。 |
namespace 文字列 | 設定されている場合、これは cainjector の範囲を単一の名前空間に制限します。設定されている場合、cainjector は構成された名前空間外の証明書を持つリソースを更新しません。 |
leaderElectionConfig github.com/cert-manager/cert-manager/pkg/apis/config/shared/v1alpha1.LeaderElectionConfig | LeaderElectionConfig は、リーダー選出の動作を構成します。 |
enableDataSourceConfig EnableDataSourceConfig | EnableDataSourceConfig は、cainjector の制御ループが、CA データの潜在的なソースとして cert-manager リソースを監視するかどうかを決定します。 |
enableInjectableConfig EnableInjectableConfig | EnableInjectableConfig は、cainjector の制御ループが、CA データの注入の潜在的なターゲットとして cert-manager リソースを監視するかどうかを決定します。 |
enablePprof bool | cainjector のプロファイリングを有効にします。 |
pprofAddress 文字列 | Go プロファイラーがリッスンするホストとポート(例:localhost:6060)。プロファイラーがパブリックアドレスで公開されないようにしてください。プロファイラーは /debug/pprof で提供されます。 |
logging k8s.io/component-base/logs/api/v1.LoggingConfiguration | logging は、cainjector のログ出力動作を構成します。https://pkg.go.dev/k8s.io/component-base@v0.27.3/logs/api/v1#LoggingConfiguration |
featureGates map[string]bool | (オプション) featureGates は、実験的な機能を有効または無効にするブール値への機能名のマップです。 |
metricsListenAddress 文字列 | メトリックエンドポイントがリッスンするホストとポートです。「0」はメトリックサーバーを無効にします。デフォルトは「0.0.0.0:9402」です。 |
metricsTLSConfig github.com/cert-manager/cert-manager/pkg/apis/config/shared/v1alpha1.TLSConfig | metricsTLSConfig は、メトリックサーバーの TLS 設定を構成するために使用されます。 |
EnableDataSourceConfig
(表示場所: CAInjectorConfiguration)
フィールド | 説明 |
---|---|
certificates bool | Certificates は、cainjector の制御ループが、CA データの潜在的なソースとして cert-manager Certificate リソースを監視するかどうかを決定します。設定されていない場合、デフォルトは true です。 |
EnableInjectableConfig
(表示場所: CAInjectorConfiguration)
フィールド | 説明 |
---|---|
validatingWebhookConfigurations bool | ValidatingWebhookConfigurations は、cainjector がアノテーションされた ValidatingWebhookConfigurations に CA データを注入する制御ループを起動するかどうかを決定します。設定されていない場合、デフォルトは true です。 |
mutatingWebhookConfigurations bool | MutatingWebhookConfigurations は、cainjector がアノテーションされた MutatingWebhookConfigurations に CA データを注入する制御ループを起動するかどうかを決定します。設定されていない場合、デフォルトは true です。 |
customResourceDefinitions bool | CustomResourceDefinitions は、cainjector がアノテーションされた CustomResourceDefinitions に CA データを注入する制御ループを起動するかどうかを決定します。設定されていない場合、デフォルトは true です。 |
apiServices bool | APIServices は、cainjector がアノテーションされた APIServices に CA データを注入する制御ループを起動するかどうかを決定します。設定されていない場合、デフォルトは true です。 |
cert-manager.io/v1
パッケージ v1 は API の v1 バージョンです。
リソースタイプ
証明書
最新で署名済みの X.509 証明書が spec.secretName
で指定された Kubernetes Secret リソースに格納されるように、Certificate リソースを作成する必要があります。
格納された証明書は、期限が切れる前に更新されます(spec.renewBefore
で構成)。
フィールド | 説明 | ||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersion 文字列 | cert-manager.io/v1 | ||||||||||||||||||||||||||||||||||||||||||||
kind 文字列 | 証明書 | ||||||||||||||||||||||||||||||||||||||||||||
metadata Kubernetes meta/v1.ObjectMeta | (オプション) 標準オブジェクトのメタデータ。詳細情報: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metadata フィールドのフィールドについては、Kubernetes API ドキュメントを参照してください。 | ||||||||||||||||||||||||||||||||||||||||||||
spec CertificateSpec | (オプション) Certificateリソースの desired state の仕様。 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
| ||||||||||||||||||||||||||||||||||||||||||||
status CertificateStatus | (オプション) Certificateの状態。これは自動的に設定および管理されます。読み取り専用。詳細情報: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
CertificateRequest
CertificateRequestは、構成済みの発行者のいずれかから署名済み証明書を要求するために使用されます。
CertificateRequestのspec
内のすべてのフィールドは、作成後は変更できません。CertificateRequestは、Ready
状態条件とstatus.failureTime
フィールドで示されるように、成功するか失敗します。
CertificateRequestはワンショットリソースであり、証明書に対する単一の時点の要求を表し、再利用できません。
フィールド | 説明 | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersion 文字列 | cert-manager.io/v1 | ||||||||||||||||||
kind 文字列 | CertificateRequest | ||||||||||||||||||
metadata Kubernetes meta/v1.ObjectMeta | (オプション) 標準オブジェクトのメタデータ。詳細情報: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata metadata フィールドのフィールドについては、Kubernetes API ドキュメントを参照してください。 | ||||||||||||||||||
spec CertificateRequestSpec | (オプション) CertificateRequestリソースの desired state の仕様。 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
| ||||||||||||||||||
status CertificateRequestStatus | (オプション) CertificateRequestの状態。これは自動的に設定および管理されます。読み取り専用。詳細情報: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
ClusterIssuer
ClusterIssuerは、issuerRef
フィールドの一部として参照できる証明書発行機関を表します。Issuerに似ていますが、クラスタスコープであるため、参照先と同じ名前空間にあるリソースだけでなく、任意の名前空間にあるリソースから参照できます。
フィールド | 説明 | ||
---|---|---|---|
apiVersion 文字列 | cert-manager.io/v1 | ||
kind 文字列 | ClusterIssuer | ||
metadata Kubernetes meta/v1.ObjectMeta |
| ||
spec IssuerSpec | ClusterIssuerリソースの desired state。
| ||
status IssuerStatus | (オプション) ClusterIssuerの状態。これは自動的に設定および管理されます。 |
Issuer
Issuerは、issuerRef
フィールドの一部として参照できる証明書発行機関を表します。単一の名前空間にスコープされているため、同じ名前空間内のリソースからのみ参照できます。
フィールド | 説明 | ||
---|---|---|---|
apiVersion 文字列 | cert-manager.io/v1 | ||
kind 文字列 | Issuer | ||
metadata Kubernetes meta/v1.ObjectMeta |
| ||
spec IssuerSpec | Issuerリソースの desired state。
| ||
status IssuerStatus | (オプション) Issuerの状態。これは自動的に設定および管理されます。 |
CAIssuer
(表示場所: IssuerConfig)
フィールド | 説明 |
---|---|
secretName 文字列 | SecretNameは、この発行者によって発行された証明書に署名するために使用される秘密の名前です。 |
crlDistributionPoints []string | (オプション) CRL配布ポイントは、X.509 v3証明書拡張機能であり、この証明書の失効を確認できるCRLの場所を特定します。設定されていない場合、証明書は配布ポイントが設定されずに発行されます。 |
ocspServers []string | (オプション) OCSPサーバーリストは、X.509 v3拡張機能であり、OCSPレスポンダのURLリストを定義します。OCSPレスポンダは、発行された証明書の失効状態を照会するために使用できます。設定されていない場合、証明書はOCSPサーバーが設定されずに発行されます。たとえば、OCSPサーバーのURLは「http://ocsp.int-x3.letsencrypt.org」です。 |
issuingCertificateURLs []string | (オプション) IssuingCertificateURLsは、この発行者が作成する証明書に埋め込むべきURLのリストです。詳細はhttps://www.rfc-editor.org/rfc/rfc5280#section-4.2.2.1を参照してください。例として、「http://ca.domain.com/ca.crt」のようなURLが考えられます。 |
CertificateAdditionalOutputFormat
(表示場所: CertificateSpec)
CertificateAdditionalOutputFormatは、Certificateリソースの追加出力形式を定義します。これらには、署名された証明書チェーンとペアになっている秘密鍵の補足データ形式が含まれています。
フィールド | 説明 |
---|---|
type CertificateOutputFormatType | Typeは、CertificateのターゲットSecretに書き込むべき形式の種類の名前です。 |
CertificateCondition
(表示場所: CertificateStatus)
CertificateConditionは、Certificateの条件情報を格納します。
フィールド | 説明 |
---|---|
type CertificateConditionType | 条件の種類。既知の値は( |
status ConditionStatus | 条件の状態。( |
lastTransitionTime Kubernetes meta/v1.Time | (オプション) LastTransitionTimeは、この条件の最後の状態変更に対応するタイムスタンプです。 |
reason 文字列 | (オプション) Reasonは、条件の最後の遷移に関する簡潔な機械可読の説明です。 |
message 文字列 | (オプション) Messageは、最後の遷移の詳細に関する人間が読める説明であり、reasonを補完します。 |
observedGeneration int64 | (オプション) 設定されている場合、これは条件が設定された基礎となった.metadata.generationを表します。たとえば、.metadata.generationが現在12だが、.status.condition[x].observedGenerationが9の場合、条件はCertificateの現在の状態に対して古くなっています。 |
CertificateConditionType(string
エイリアス)
(表示場所: CertificateCondition)
CertificateConditionTypeは、Certificateの条件値を表します。
値 | 説明 |
---|---|
"Issuing" | 発行が必要な場合、Certificateリソースに追加される条件です。次の場合、この条件は自動的に追加され、trueに設定されます。* ターゲットSecretにキーペアデータが存在しない * Secretに格納されているデータがデコードできない * 秘密鍵と証明書の公開鍵が一致しない * 現在のリビジョンに対するCertificateRequestが存在し、Secretに格納されている証明書データがCertificateRequestの 発行が完了すると、「issuing」コントローラーによって削除されます。 |
"Ready" | CertificateConditionReadyは、証明書が使用できる状態であることを示します。これは次のように定義されます。- ターゲットシークレットが存在する - ターゲットシークレットには、期限切れになっていない証明書が含まれている - ターゲットシークレットには、証明書に対して有効な秘密鍵が含まれている - commonNameとdnsNames属性は、Certificateで指定されたものと一致する |
CertificateKeystores
(表示場所: CertificateSpec)
CertificateKeystoresは、Certificateの出力Secretに作成される追加のキーストア出力形式を構成します。
フィールド | 説明 |
---|---|
jks JKSKeystore | (オプション) JKSは、 |
pkcs12 PKCS12Keystore | (オプション) PKCS12は、 |
CertificateOutputFormatType(string
エイリアス)
(表示場所: CertificateAdditionalOutputFormat)
CertificateOutputFormatTypeは、CertificateのターゲットSecretに書き込む追加の出力形式を指定します。許可される値はDER
またはCombinedPEM
です。TypeがDER
に設定されている場合、秘密鍵のバイナリ形式を含む追加のエントリkey.der
がSecretに書き込まれます。TypeがCombinedPEM
に設定されている場合、PEM形式の秘密鍵と署名された証明書チェーン(tls.key + tls.crt連結)を含む追加のエントリtls-combined.pem
がSecretに書き込まれます。
値 | 説明 |
---|---|
"CombinedPEM" | CertificateOutputFormatCombinedPEMは、PEM形式のCertificateの署名された証明書チェーンと秘密鍵を、 |
"DER" | CertificateOutputFormatDERは、DERバイナリ形式のCertificateの秘密鍵を |
CertificatePrivateKey
(表示場所: CertificateSpec)
CertificatePrivateKeyには、Certificateコントローラーで使用される秘密鍵の構成オプションが含まれています。これらには、キーアルゴリズムとサイズ、使用されるエンコーディング、ローテーションポリシーが含まれます。
フィールド | 説明 |
---|---|
rotationPolicy PrivateKeyRotationPolicy | (オプション) RotationPolicyは、再発行処理時に秘密鍵をどのように再生成するかを制御します。
|
encoding PrivateKeyEncoding | (オプション) この証明書の秘密鍵をエンコードする秘密鍵暗号化標準(PKCS)エンコーディングです。 指定されている場合、許可される値は、それぞれPKCS#1とPKCS#8を表す |
algorithm PrivateKeyAlgorithm | (オプション) Algorithmは、この証明書の対応する秘密鍵の秘密鍵アルゴリズムです。 指定されている場合、許可される値は |
size int | (オプション) Sizeは、この証明書の対応する秘密鍵のキービットサイズです。
|
CertificateRequestCondition
(表示場所: CertificateRequestStatus)
CertificateRequestConditionは、CertificateRequestの条件情報を格納します。
フィールド | 説明 |
---|---|
type CertificateRequestConditionType | 条件の種類。既知の値は( |
status ConditionStatus | 条件の状態。( |
lastTransitionTime Kubernetes meta/v1.Time | (オプション) LastTransitionTimeは、この条件の最後の状態変更に対応するタイムスタンプです。 |
reason 文字列 | (オプション) Reasonは、条件の最後の遷移に関する簡潔な機械可読の説明です。 |
message 文字列 | (オプション) Messageは、最後の遷移の詳細に関する人間が読める説明であり、reasonを補完します。 |
CertificateRequestConditionType(string
エイリアス)
(表示場所: CertificateRequestCondition)
CertificateRequestConditionTypeは、Certificateの条件値を表します。
値 | 説明 |
---|---|
"Approved" | CertificateRequestConditionApprovedは、証明書要求が承認され、署名準備が完了したことを示します。条件の状態が |
"Denied" | CertificateRequestConditionDeniedは、証明書要求が拒否され、署名してはならないことを示します。条件の状態が |
"InvalidRequest" | CertificateRequestConditionInvalidRequestは、入力パラメーターの少なくとも1つが無効であるため、証明書署名者が要求の署名を拒否したことを示します。要求が拒否された理由に関する追加情報は、 |
"Ready" | CertificateRequestConditionReadyは、証明書が使用できる状態であることを示します。これは次のように定義されます。- ターゲット証明書がCertificateRequest.Statusに存在する |
CertificateRequestSpec
(表示場所: CertificateRequest)
CertificateRequestSpecは、CertificateRequestの目的の状態を定義します。
注:発行者は、要求された属性を無視したり、変更したりすることを選択できることに注意することが重要です。発行者が証明書要求を署名済み証明書にどのようにマッピングするかは、発行者自身の全責任です。たとえば、極端な例として、isCAの値を反転させる発行者は自由にそうすることができます。
フィールド | 説明 |
---|---|
duration Kubernetes meta/v1.Duration | (オプション) 要求された証明書の「期間」(つまり有効期間)。発行者は、他の要求された属性と同様に、要求された期間を無視することを選択する場合があります。 |
issuerRef ObjectReference | 証明書の発行を担当する発行者への参照。発行者が名前空間スコープである場合、Certificateと同じ名前空間に存在する必要があります。発行者がクラスタスコープである場合、任意の名前空間から使用できます。 参照の |
request []byte | 発行者に送信して署名するPEMエンコードされたX.509証明書署名要求。 CSRにBasicConstraints拡張機能がある場合、そのisCA属性は、このCertificateRequestの |
isCA bool | (オプション) 要求された基本制約isCA値。発行者は、他の要求された属性と同様に、要求されたisCA値を無視することを選択する場合があります。 注: trueの場合、 |
usages []KeyUsage | (オプション) 要求されたキーの使用法と拡張キーの使用法。 注: 設定されていない場合、デフォルトは |
username 文字列 | (オプション) Usernameには、CertificateRequestを作成したユーザーの名前が含まれています。作成時にcert-manager webhookによって設定され、変更できません。 |
uid 文字列 | (オプション) UIDには、CertificateRequestを作成したユーザーのuidが含まれています。作成時にcert-manager webhookによって設定され、変更できません。 |
groups []string | (オプション) Groupsには、CertificateRequestを作成したユーザーのグループメンバーシップが含まれています。作成時にcert-manager webhookによって設定され、変更できません。 |
extra map[string][]string | (オプション) Extraには、CertificateRequestを作成したユーザーの追加属性が含まれています。作成時にcert-manager webhookによって設定され、変更できません。 |
CertificateRequestStatus
(表示場所: CertificateRequest)
CertificateRequestStatusは、CertificateRequestと結果として得られる署名済み証明書の観測状態を定義します。
フィールド | 説明 |
---|---|
conditions []CertificateRequestCondition | (オプション) CertificateRequestの状態を示す状態条件のリストです。既知の条件の種類は |
certificate []byte | (オプション) 証明書署名要求の結果として得られた、PEMエンコードされたX.509証明書です。設定されていない場合、CertificateRequestは完了していないか、失敗しています。失敗に関する詳細情報は、 |
ca []byte | (オプション) 署名者のPEMエンコードされたX.509証明書(CA(認証局)とも呼ばれます)。これは、さまざまな発行者によって最善の努力で設定されます。設定されていない場合、CAは不明/利用できないと見なされます。 |
failureTime Kubernetes meta/v1.Time | (オプション) FailureTimeは、このCertificateRequestが失敗した時間を格納します。これは、ガベージコレクションとバックオフに影響を与えるために使用されます。 |
CertificateSecretTemplate
(表示場所: CertificateSpec)
CertificateSecretTemplateは、CertificateSpec.secretName
で指定されたKubernetes Secretリソースにコピーされるデフォルトのラベルとアノテーションを定義します。
フィールド | 説明 |
---|---|
annotations map[string]string | (オプション) Annotationsは、ターゲットKubernetes Secretにコピーされるキーバリューマップです。 |
labels map[string]string | (オプション) Labelsは、ターゲットKubernetes Secretにコピーされるキーバリューマップです。 |
CertificateSpec
(表示場所: Certificate)
CertificateSpecは、Certificateの目的の状態を定義します。
注:仕様には多くの「要求された」証明書属性が含まれています。発行者は、これらの要求された属性を無視したり、変更したりすることを選択できることに注意することが重要です。発行者が証明書要求を署名済み証明書にどのようにマッピングするかは、発行者自身の全責任です。たとえば、極端な例として、isCAの値を反転させる発行者は自由にそうすることができます。
有効なCertificateには、CommonName、LiteralSubject、DNSName、またはURIの少なくとも1つが有効である必要があります。
フィールド | 説明 |
---|---|
subject X509Subject | (オプション) 要求されたX509証明書のサブジェクト属性のセット。詳細情報: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.6 common name属性は、 |
literalSubject 文字列 | (オプション) LDAPの「識別名の文字列表現」[1]を使用して表された、要求されたX.509証明書のサブジェクト。重要:LDAP文字列形式は、サブジェクト内の属性の順序も指定します。これは、LDAP認証用の証明書を発行する場合に重要です。例:
|
commonName 文字列 | (オプション) 要求されたcommon name X509証明書のサブジェクト属性。詳細情報: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.6 注:サブジェクト代替名が設定されている場合、TLSクライアントはこの値を無視します(https://tools.ietf.org/html/rfc6125#section-6.4.4を参照)。 無効なCSRの生成を避けるために、長さは64文字以下にする必要があります。 |
duration Kubernetes meta/v1.Duration | (オプション) 要求された証明書の「期間」(つまり有効期間)。発行者は、他の要求された属性と同様に、要求された期間を無視することを選択する場合があります。 設定されていない場合、デフォルトは90日です。最小許容期間は1時間です。値は、Go time.ParseDurationで受け入れられる単位である必要があります。https://go.dokyumento.jp/pkg/time/#ParseDuration。 |
renewBefore Kubernetes meta/v1.Duration | (オプション) 現在発行されている証明書の有効期限が切れる前に、cert-managerが証明書を更新する期間。たとえば、証明書の有効期間が60分であり、 注:発行された証明書の実際の有効期間を使用して、更新時間が決定されます。発行者が要求されたものとは異なる有効期間の証明書を返す場合、cert-managerは発行された証明書の有効期間を使用します。 設定されていない場合、デフォルトは発行された証明書の有効期間の1⁄3です。最小許容値は5分です。値は、Go time.ParseDurationで受け入れられる単位である必要があります。https://go.dokyumento.jp/pkg/time/#ParseDuration。 |
renewBeforePercentage int32 | (オプション) 注:発行された証明書の実際の有効期間を使用して、更新時間が決定されます。発行者が要求されたものとは異なる有効期間の証明書を返す場合、cert-managerは発行された証明書の有効期間を使用します。 値は(0,100)の範囲内の整数である必要があります。 |
dnsNames []string | (オプション) 要求されたDNSサブジェクト代替名。 |
ipAddresses []string | (オプション) 要求されたIPアドレスサブジェクト代替名。 |
uris []string | (オプション) 要求されたURIサブジェクト代替名。 |
otherNames []OtherName | (オプション) |
emailAddresses []string | (オプション) 要求されたメールサブジェクト代替名。 |
secretName 文字列 | このCertificateリソースによって自動的に作成および管理されるSecretリソースの名前。指定された発行者によって署名された秘密鍵と証明書が格納されます。Secretリソースは、Certificateリソースと同じ名前空間に存在します。 |
secretTemplate CertificateSecretTemplate | (オプション) CertificateのSecretにコピーするアノテーションとラベルを定義します。Secretのアノテーションとラベルは、追加または削除されたときにSecretTemplateに表示されるように変更されます。SecretTemplateのアノテーションは、cert-managerがCertificateのSecretに設定する基本的なアノテーションセットと組み合わせて追加され、上書きすることはできません。 |
keystores CertificateKeystores | (オプション) CertificateのSecretに格納される追加のキーストア出力形式。 |
issuerRef ObjectReference | 証明書の発行を担当する発行者への参照。発行者が名前空間スコープである場合、Certificateと同じ名前空間に存在する必要があります。発行者がクラスタスコープである場合、任意の名前空間から使用できます。 参照の |
isCA bool | (オプション) 要求された基本制約isCA値。isCA値は、作成されたCertificateRequestリソースの trueの場合、 |
usages []KeyUsage | (オプション) 要求されたキーの使用法と拡張キーの使用法。これらの使用法は、作成されたCertificateRequestリソースの 設定されていない場合、デフォルトは |
privateKey CertificatePrivateKey | (オプション) 秘密鍵のオプション。これには、キーアルゴリズムとサイズ、使用されるエンコーディング、ローテーションポリシーが含まれます。 |
encodeUsagesInRequest bool | (オプション) エンコードされたCSRにKeyUsageとExtKeyUsage拡張を設定するかどうか。 このオプションのデフォルトはtrueであり、ターゲット発行者がこれらのX509 KeyUsage/ExtKeyUsage拡張機能を含むCSRをサポートしていない場合にのみ無効にする必要があります。 |
revisionHistoryLimit int32 | (オプション) Certificateの履歴に保持されるCertificateRequestリビジョンの最大数。各リビジョンは、作成時、更新時、または仕様の変更時にこのCertificateによって作成された単一の 設定されている場合、revisionHistoryLimitは |
additionalOutputFormats []CertificateAdditionalOutputFormat | (オプション) このCertificateのターゲットSecretに書き込む秘密鍵と署名済み証明書チェーンの追加の出力形式を定義します。 これはデフォルトで有効になっているベータ機能です。コントローラーコンポーネントとWebhookコンポーネントの両方で |
nameConstraints NameConstraints | (オプション) 非CA証明書では使用してはならないx.509証明書NameConstraint拡張。詳細情報: https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.10 これはアルファ機能であり、コントローラーコンポーネントとWebhookコンポーネントの両方で |
CertificateStatus
(表示場所: Certificate)
CertificateStatusは、Certificateの観測状態を定義します。
フィールド | 説明 |
---|---|
conditions []CertificateCondition | (オプション) 証明書の状態を示す状態条件のリストです。既知の条件の種類は |
lastFailureTime Kubernetes meta/v1.Time | (オプション) LastFailureTimeは、このCertificateの最新の発行が失敗した場合にのみ設定され、失敗の時間を含みます。発行が失敗した場合、次回の発行までの遅延は、式time.Hour * 2 ^ (failedIssuanceAttempts - 1)を使用して計算されます。最新の発行が成功した場合、このフィールドは設定解除されます。 |
notBefore Kubernetes meta/v1.Time | (オプション) このリソースの |
notAfter Kubernetes meta/v1.Time | (オプション) このリソースの |
renewalTime Kubernetes meta/v1.Time | (オプション) RenewalTimeは、証明書が次に更新される時刻です。設定されていない場合、今後の更新はスケジュールされていません。 |
revision int | (オプション) 発行された証明書の現在の「リビジョン」です。 CertificateRequestリソースが作成されると、 このフィールドは、証明書を発行するために使用されたCertificateRequestリソースの注釈の値に設定されます。 CertificateRequestリソースに値を保持することで、証明書コントローラーは、注釈内のrevision値がこのフィールドより大きいかどうかをチェックすることにより、リクエストが古い発行の一部であるか、進行中のrevisionの発行の一部であるかを判断できます。 |
nextPrivateKeySecretName 文字列 | (オプション) 次の証明書の繰り返しで使用される秘密鍵を含むSecretリソースの名前。 |
failedIssuanceAttempts int | (オプション) これまでの連続した発行失敗試行回数。このフィールドは、発行が成功すると(設定されている場合)削除され、発行が失敗した場合は未設定で1に設定されます。発行が失敗した場合、次回の発行までの遅延は、time.Hour * 2 ^ (failedIssuanceAttempts - 1)という式を使用して計算されます。 |
GenericIssuer
IssuerCondition
(表示場所: IssuerStatus)
IssuerConditionは、Issuerに関する条件情報を格納します。
フィールド | 説明 |
---|---|
type IssuerConditionType | 条件のタイプ。既知の値は( |
status ConditionStatus | 条件の状態。( |
lastTransitionTime Kubernetes meta/v1.Time | (オプション) LastTransitionTimeは、この条件の最後の状態変更に対応するタイムスタンプです。 |
reason 文字列 | (オプション) Reasonは、条件の最後の遷移に関する簡潔な機械可読の説明です。 |
message 文字列 | (オプション) Messageは、最後の遷移の詳細に関する人間が読める説明であり、reasonを補完します。 |
observedGeneration int64 | (オプション) 設定されている場合、これは条件が設定された基礎となる.metadata.generationを表します。例えば、.metadata.generationが現在12だが、.status.condition[x].observedGenerationが9の場合、条件はIssuerの現在の状態に対して古くなっています。 |
IssuerConditionType(string
alias)
(表示場所: IssuerCondition)
IssuerConditionTypeは、Issuer条件の値を表します。
値 | 説明 |
---|---|
"Ready" | IssuerConditionReadyは、特定のIssuer条件が準備完了状態で、証明書を発行できることを表します。この条件の |
IssuerConfig
(表示場所: IssuerSpec)
発行者の設定。これらのうち、1つのみを設定できます。
フィールド | 説明 |
---|---|
acme ACMEIssuer | (オプション) ACMEは、この発行者をRFC8555(ACME)サーバーと通信して署名付きx509証明書を取得するように設定します。 |
ca CAIssuer | (オプション) CAは、Secretリソースに格納されている署名CAキーペアを使用して証明書に署名するようにこの発行者を設定します。これは、cert-managerによって管理される内部PKIを構築するために使用されます。 |
vault VaultIssuer | (オプション) Vaultは、HashiCorp Vault PKIバックエンドを使用して証明書に署名するようにこの発行者を設定します。 |
selfSigned SelfSignedIssuer | (オプション) SelfSignedは、CertificateRequestオブジェクトの作成に使用された秘密鍵を使用して証明書を「自己署名」するようにこの発行者を設定します。 |
venafi VenafiIssuer | (オプション) Venafiは、Venafi TPPまたはVenafi Cloudポリシーゾーンを使用して証明書に署名するようにこの発行者を設定します。 |
IssuerSpec
(表示場所: ClusterIssuer、Issuer)
IssuerSpecは、Issuerの仕様です。これには、発行者に必要な設定が含まれます。
フィールド | 説明 |
---|---|
IssuerConfig IssuerConfig | ( |
IssuerStatus
(表示場所: ClusterIssuer、Issuer)
IssuerStatusは、Issuerに関する状態情報を格納します。
フィールド | 説明 |
---|---|
conditions []IssuerCondition | (オプション) CertificateRequestの状態を示す状態条件のリスト。既知の条件タイプは |
acme ACMEIssuerStatus | (オプション) ACME固有の状態オプション。このフィールドは、発行者が証明書の発行にACMEサーバーを使用するように設定されている場合にのみ設定する必要があります。 |
JKSKeystore
(表示場所: CertificateKeystores)
JKSは、spec.secretName
SecretリソースにJKSキーストアを格納するためのオプションを構成します。
フィールド | 説明 |
---|---|
create bool | Createは、証明書に対してJKSキーストアの作成を有効にします。Trueの場合、 |
passwordSecretRef SecretKeySelector | PasswordSecretRefは、JKSキーストアの暗号化に使用されるパスワードを含むSecretリソース内のキーへの参照です。 |
alias 文字列 | (オプション) Aliasは、キーストア内のキーのエイリアスを指定します。JKS形式で必要です。指定しない場合、デフォルトのエイリアス |
KeyUsage(string
alias)
(表示場所: CertificateRequestSpec、CertificateSpec)
KeyUsageは、キーの有効な使用コンテキストを指定します。参照: https://tools.ietf.org/html/rfc5280#section-4.2.1.3 https://tools.ietf.org/html/rfc5280#section-4.2.1.12
有効なKeyUsage値は以下のとおりです。「signing」、「digital signature」、「content commitment」、「key encipherment」、「key agreement」、「data encipherment」、「cert sign」、「crl sign」、「encipher only」、「decipher only」、「any」、「server auth」、「client auth」、「code signing」、「email protection」、「s/mime」、「ipsec end system」、「ipsec tunnel」、「ipsec user」、「timestamping」、「ocsp signing」、「microsoft sgc」、「netscape sgc」
値 | 説明 |
---|---|
"any" | |
"crl sign" | |
"cert sign" | |
"client auth" | |
"code signing" | |
"content commitment" | |
"data encipherment" | |
"decipher only" | |
"digital signature" | |
"email protection" | |
"encipher only" | |
"ipsec end system" | |
"ipsec tunnel" | |
"ipsec user" | |
"key agreement" | |
"key encipherment" | |
"microsoft sgc" | |
"netscape sgc" | |
"ocsp signing" | |
"s/mime" | |
"server auth" | |
"signing" | |
"timestamping" |
NameConstraintItem
(表示場所: NameConstraints)
フィールド | 説明 |
---|---|
dnsDomains []string | (オプション) DNSDomainsは、許可または除外されるDNSドメインのリストです。 |
ipRanges []string | (オプション) IPRangesは、許可または除外されるIP範囲のリストです。有効なCIDR表記である必要があります。 |
emailAddresses []string | (オプション) EmailAddressesは、許可または除外されるメールアドレスのリストです。 |
uriDomains []string | (オプション) URIDomainsは、許可または除外されるURIドメインのリストです。 |
NameConstraints
(表示場所: CertificateSpec)
NameConstraintsは、x509 NameConstraintsを表すタイプです。
フィールド | 説明 |
---|---|
critical bool | (オプション) trueの場合、名前の制約は重要としてマークされます。 |
permitted NameConstraintItem | (オプション) Permittedには、名前が存在する必要がある制約が含まれています。 |
excluded NameConstraintItem | (オプション) Excludedには、許可されない制約が含まれています。excludedフィールドの制限に一致する名前は、permittedに表示される情報に関係なく無効です。 |
OtherName
(表示場所: CertificateSpec)
フィールド | 説明 |
---|---|
oid 文字列 | OIDは、otherName SANのオブジェクト識別子です。オブジェクト識別子は、ドット付き文字列(例:「1.2.840.113556.1.4.221」)で表す必要があります。 |
utf8Value 文字列 | utf8Valueは、otherName SANの文字列値です。utf8Valueは、otherName SANの値として設定する有効なUTF8文字列を受け入れます。 |
PKCS12Keystore
(表示場所: CertificateKeystores)
PKCS12は、spec.secretName
SecretリソースにPKCS12キーストアを格納するためのオプションを構成します。
フィールド | 説明 |
---|---|
create bool | Createは、証明書に対してPKCS12キーストアの作成を有効にします。Trueの場合、 |
passwordSecretRef SecretKeySelector | PasswordSecretRefは、PKCS12キーストアの暗号化に使用されるパスワードを含むSecretリソース内のキーへの参照です。 |
profile PKCS12Profile | (オプション) Profileは、PKCS12キーストアの作成に使用されるキーと証明書の暗号化アルゴリズム、およびHMACアルゴリズムを指定します。下位互換性のために、デフォルト値は 指定されている場合、許可される値は次のとおりです。 |
PKCS12Profile(string
alias)
(表示場所: PKCS12Keystore)
値 | 説明 |
---|---|
"LegacyDES" | 参照: https://pkg.go.dev/software.sslmate.com/src/go-pkcs12#LegacyDES |
"LegacyRC2" | 参照: https://pkg.go.dev/software.sslmate.com/src/go-pkcs12#LegacyRC2 |
"Modern2023" | 参照: https://pkg.go.dev/software.sslmate.com/src/go-pkcs12#Modern2023 |
PrivateKeyAlgorithm(string
alias)
(表示場所: CertificatePrivateKey)
値 | 説明 |
---|---|
"ECDSA" | ECDSA秘密鍵アルゴリズム。 |
"Ed25519" | Ed25519秘密鍵アルゴリズム。 |
"RSA" | RSA秘密鍵アルゴリズム。 |
PrivateKeyEncoding(string
alias)
(表示場所: CertificatePrivateKey)
値 | 説明 |
---|---|
"PKCS1" | PKCS1秘密鍵エンコーディング。PKCS1は、ヘッダーに秘密鍵アルゴリズム、本文に秘密鍵を含むPEMブロックを生成します。これを用いる鍵は、 |
"PKCS8" | PKCS8秘密鍵エンコーディング。PKCS8は、静的なヘッダーと、秘密鍵アルゴリズムと秘密鍵の両方を本文に含むPEMブロックを生成します。このエンコーディングを使用するキーは、 |
PrivateKeyRotationPolicy(string
alias)
(表示場所: CertificatePrivateKey)
証明書の発行時に秘密鍵をどのように生成または取得するかを示します。
SelfSignedIssuer
(表示場所: IssuerConfig)
CertificateRequestオブジェクトの作成に使用された秘密鍵を使用して証明書を「自己署名」するように発行者を設定します。
フィールド | 説明 |
---|---|
crlDistributionPoints []string | (オプション) CRL配布ポイントは、この証明書の失効をチェックできるCRLの場所を識別するX.509 v3証明書拡張です。設定されていない場合、証明書はCDPなしで発行されます。値は文字列です。 |
ServiceAccountRef
(表示場所: VaultKubernetesAuth)
ServiceAccountRefは、cert-managerがトークンを要求するために使用するサービスアカウントです。デフォルトのaudienceはcert-managerによって生成され、Issuerの場合はvault://namespace-name/issuer-name
、ClusterIssuerの場合はvault://issuer-name
という形式になります。トークンの有効期限もcert-managerによって10分に設定されます。
フィールド | 説明 |
---|---|
name 文字列 | トークンを要求するために使用される ServiceAccount の名前です。 |
audiences []string | (オプション) TokenAudiencesは、Vaultに渡されるトークンに含める追加のaudienceのオプションリストです。発行者の名前空間と名前で構成されるデフォルトのトークンは常に含まれます。 |
VaultAppRole
(表示場所: VaultAuth)
VaultAppRoleは、Kubernetes Secretリソースに格納されているロールとシークレットを使用して、App Role認証メカニズムを使用してVaultを認証します。
フィールド | 説明 |
---|---|
path 文字列 | VaultにApp Role認証バックエンドがマウントされているパス(例:「approle」)。 |
roleId 文字列 | Vaultで認証バックエンドを設定する際にApp Role認証バックエンドで設定されたRoleID。 |
secretRef SecretKeySelector | Vaultとの認証に使用されるApp Roleシークレットを含むSecret内のキーへの参照。 |
VaultAuth
(表示場所: VaultIssuer)
VaultAuthは、Vaultサーバーと認証するために使用される設定です。優先順位は[tokenSecretRef
、appRole
、clientCertificate
、kubernetes
]です。
フィールド | 説明 |
---|---|
tokenSecretRef SecretKeySelector | (オプション) TokenSecretRefは、トークンを提示してVaultを認証します。 |
appRole VaultAppRole | (オプション) AppRoleは、Kubernetes Secretリソースに格納されているロールとシークレットを使用して、App Role認証メカニズムを使用してVaultを認証します。 |
clientCertificate VaultClientCertificateAuth | (オプション) ClientCertificateは、リクエストのTLSハンドシェイク中にクライアント証明書を提示してVaultを認証します。HTTPSプロトコルを使用する場合にのみ機能します。 |
kubernetes VaultKubernetesAuth | (オプション) Kubernetesは、名前付きSecretリソースに格納されているServiceAccountトークンをVaultサーバーに渡すことでVaultを認証します。 |
VaultClientCertificateAuth
(表示場所: VaultAuth)
VaultKubernetesAuthは、Secretに格納されているクライアント証明書を使用してVaultに対して認証するために使用されます。
フィールド | 説明 |
---|---|
mountPath 文字列 | (オプション) Vault の mountPath は、Vault 認証時に使用するマウントパスです。例えば、値を |
secretName 文字列 | (オプション) TLS クライアント認証を使用して Vault を認証するために使用される、「kubernetes.io/tls」タイプの Kubernetes Secret への参照(そのため、tls.crt と tls.key を含みます)。 |
name 文字列 | (オプション) 認証対象の証明書ロールの名前。設定されていない場合、使用可能な場合は任意の証明書ロールと一致させます。 |
VaultIssuer
(表示場所: IssuerConfig)
HashiCorp Vault PKI バックエンドを使用して証明書に署名する発行者を構成します。
フィールド | 説明 |
---|---|
auth VaultAuth | Auth は、cert-manager が Vault サーバーでどのように認証するかを構成します。 |
server 文字列 | Server は Vault サーバーの接続アドレスです。例:「https://vault.example.com:8200」。 |
path 文字列 | Path は Vault PKI バックエンドの |
namespace 文字列 | (オプション) Vault 名前空間の名前。名前空間は、Vault Enterprise 内の機能のセットであり、Vault 環境がセキュアなマルチテナントをサポートできるようにします。例:「ns1」。名前空間の詳細については、https://www.vaultproject.io/docs/enterprise/namespaces を参照してください。 |
caBundle []byte | (オプション) Vault から提示される証明書チェーンの検証に使用される、PEM CA の Base64 エンコードされたバンドル。Vault への接続に HTTPS を使用する場合にのみ使用され、HTTP 接続の場合は無視されます。CABundleSecretRef とは相互に排他的です。CABundle と CABundleSecretRef のどちらも定義されていない場合、cert-manager コントローラーコンテナ内の証明書バンドルを使用して TLS 接続を検証します。 |
caBundleSecretRef SecretKeySelector | (オプション) HTTPS を使用する場合に、Vault から提示される証明書チェーンの検証に使用される、PEM エンコードされた CA のバンドルを含む Secret への参照。CABundle とは相互に排他的です。CABundle と CABundleSecretRef のどちらも定義されていない場合、cert-manager コントローラーコンテナ内の証明書バンドルを使用して TLS 接続を検証します。Secret のキーが指定されていない場合、cert-manager はデフォルトで「ca.crt」を使用します。 |
clientCertSecretRef SecretKeySelector | (オプション) Vault サーバーが mTLS を要求する場合に使用する、PEM エンコードされたクライアント証明書を含む Secret への参照。 |
clientKeySecretRef SecretKeySelector | (オプション) Vault サーバーが mTLS を要求する場合に使用する、PEM エンコードされたクライアント秘密鍵を含む Secret への参照。 |
VaultKubernetesAuth
(表示場所: VaultAuth)
Secret に保存されている Kubernetes ServiceAccount トークンを使用して Vault を認証します。
フィールド | 説明 |
---|---|
mountPath 文字列 | (オプション) Vault の mountPath は、Vault 認証時に使用するマウントパスです。例えば、値を |
secretRef SecretKeySelector | (オプション) Vault 認証に使用される Kubernetes ServiceAccount JWT を含む、必須の Secret フィールド。「環境認証情報」の使用はサポートされていません。 |
serviceAccountRef ServiceAccountRef | (オプション) バインドトークン(「投影トークン」とも呼ばれる)を要求するために使用されるサービスアカウントへの参照。「secretRef」を使用する場合と比較して、このフィールドを使用すると、静的にバインドされたトークンに依存しなくなります。このフィールドを使用するには、cert-manager がトークンを要求できるように RBAC ルールを構成する必要があります。 |
ロール 文字列 | 想定する Vault ロールを含む必須フィールド。ロールは、Kubernetes ServiceAccount と一連の Vault ポリシーをバインドします。 |
VenafiCloud
(表示場所: VenafiIssuer)
VenafiCloud は、Venafi Cloud の接続構成の詳細を定義します。
フィールド | 説明 |
---|---|
url 文字列 | (オプション) URL は Venafi Cloud の基本 URL です。デフォルトは「https://api.venafi.cloud/v1」。 |
apiTokenSecretRef SecretKeySelector | APITokenSecretRef は、Venafi Cloud API トークンのシークレットキーセレクターです。 |
VenafiIssuer
(表示場所: IssuerConfig)
Venafi TPP または Cloud ポリシーゾーンを使用して証明書に署名する発行者を構成します。
フィールド | 説明 |
---|---|
zone 文字列 | Zone は、この発行者に対して使用する Venafi ポリシーゾーンです。Venafi プラットフォームに対して行われるすべての要求は、名前付きゾーンポリシーによって制限されます。このフィールドは必須です。 |
tpp VenafiTPP | (オプション) TPP は、Trust Protection Platform の設定を指定します。TPP と Cloud のいずれか一方のみを指定できます。 |
cloud VenafiCloud | (オプション) Cloud は、Venafi Cloud の設定を指定します。TPP と Cloud のいずれか一方のみを指定できます。 |
VenafiTPP
(表示場所: VenafiIssuer)
VenafiTPP は、Venafi TPP インスタンスの接続構成の詳細を定義します。
フィールド | 説明 |
---|---|
url 文字列 | URL は、Venafi TPP インスタンスの vedsdk エンドポイントの基本 URL です。例:「https://tpp.example.com/vedsdk」。 |
credentialsRef LocalObjectReference | CredentialsRef は、Venafi TPP API 資格情報を含む Secret への参照です。シークレットには、アクセストークン認証の場合はキー「access-token」、APIキー認証の場合はキー「username」と「password」の2つのキーを含める必要があります。 |
caBundle []byte | (オプション) TPP サーバーから提示される証明書チェーンの検証に使用される、PEM CA の Base64 エンコードされたバンドル。HTTPS を使用する場合にのみ使用され、HTTP の場合は無視されます。定義されていない場合、cert-manager コントローラーコンテナ内の証明書バンドルを使用してチェーンを検証します。 |
caBundleSecretRef SecretKeySelector | (オプション) TPP サーバーから提示される証明書チェーンの検証に使用される、PEM CA の Base64 エンコードされたバンドルを含む Secret への参照。HTTPS を使用する場合にのみ使用され、HTTP の場合は無視されます。CABundle とは相互に排他的です。CABundle と CABundleSecretRef のどちらも定義されていない場合、cert-manager コントローラーコンテナ内の証明書バンドルを使用して TLS 接続を検証します。 |
X509Subject
(表示場所: CertificateSpec)
X509Subject 完全な X509 名の指定
フィールド | 説明 |
---|---|
organizations []string | (オプション) 証明書で使用される組織。 |
countries []string | (オプション) 証明書で使用される国。 |
organizationalUnits []string | (オプション) 証明書で使用される組織単位。 |
localities []string | (オプション) 証明書で使用される都市。 |
provinces []string | (オプション) 証明書で使用される州/県。 |
streetAddresses []string | (オプション) 証明書で使用される住所。 |
postalCodes []string | (オプション) 証明書で使用される郵便番号。 |
serialNumber 文字列 | (オプション) 証明書で使用されるシリアル番号。 |
controller.config.cert-manager.io/v1alpha1
パッケージ v1alpha1 は、コントローラー構成 API の v1alpha1 バージョンです。
リソースタイプ
ACMEDNS01Config
(表示場所: ControllerConfiguration)
フィールド | 説明 |
---|---|
recursiveNameservers []string | 各ネームサーバーは、標準的な再帰的 DNS サーバーの IP アドレスとポート、または RFC 8484 DNS over HTTPS エンドポイントへのエンドポイントのいずれかになります。例えば、以下の値は有効です。 - "8.8.8.8:53" (標準 DNS) - "https://1.1.1.1/dns-query" (DNS over HTTPS) |
recursiveNameserversOnly bool | true の場合、cert-manager は ACME DNS01 自己チェックを実行するために、構成済みの DNS リゾルバーのみをクエリします。これは、権限のあるネームサーバーへのアクセスが制限されている DNS 制約環境で役立ちます。このオプションを有効にすると、再帰的ネームサーバーによって実行されるキャッシングのために、DNS01 自己チェックに時間がかかる場合があります。 |
checkRetryPeriod github.com/cert-manager/cert-manager/pkg/apis/config/shared/v1alpha1.Duration | コントローラーが伝播チェックの間待機する期間。名前とは異なり、このフラグは DNS01 と HTTP01 の両方のチャレンジ伝播チェックの待機期間を構成するために使用されます。DNS01 チャレンジの場合、伝播チェックは、チャレンジトークンを含む TXT レコードが作成されたことを検証します。HTTP01 チャレンジの場合、伝播チェックは、チャレンジトークンがチャレンジURLで提供されていることを検証します。これは有効な期間文字列である必要があります。例:180s または 1h |
ACMEHTTP01Config
(表示場所: ControllerConfiguration)
フィールド | 説明 |
---|---|
solverImage 文字列 | ACME HTTP01 チャレンジを解決するために使用する Docker イメージ。新しい機能をテストしたり、cert-manager を開発したりする場合を除き、このパラメーターを変更する必要はほとんどありません。 |
solverResourceRequestCPU 文字列 | 新しい ACME HTTP01 チャレンジソルバーポッドを生成する際の、リソース要求 CPU サイズを定義します。 |
solverResourceRequestMemory 文字列 | 新しい ACME HTTP01 チャレンジソルバーポッドを生成する際の、リソース要求メモリサイズを定義します。 |
solverResourceLimitsCPU 文字列 | 新しい ACME HTTP01 チャレンジソルバーポッドを生成する際の、リソース制限 CPU サイズを定義します。 |
solverResourceLimitsMemory 文字列 | 新しい ACME HTTP01 チャレンジソルバーポッドを生成する際の、リソース制限メモリサイズを定義します。 |
solverRunAsNonRoot bool | 問題のトラブルシューティングのために、http01 ソルバーを root として実行する機能を定義します。 |
solverNameservers []string | ACME HTTP01 チェック要求に使用される、コンマ区切りの DNS サーバーエンドポイントのリスト。これは、ホストとポートを含むリストである必要があります。例:["8.8.8.8:53","8.8.4.4:53"] HTTP01 チェックを実行するカスタムネームサーバーのリストを指定できます。 |
ControllerConfiguration
フィールド | 説明 |
---|---|
kubeConfig 文字列 | kubeConfig は、Kubernetes apiserver に接続するために使用される kubeconfig ファイルです。指定されていない場合、コントローラーはインクラスタ構成の読み込みを試みます。 |
apiServerHost 文字列 | apiServerHost は、API サーバーの接続アドレスをオーバーライドするために使用されます。非推奨:代わりに |
kubernetesAPIQPS float32 | Kubernetes apiserver への最大クエリ毎秒のリクエストを示します。TODO: 浮動小数点は推奨されません。resource.Quantity を使用する方が良いかもしれませんか?https://kubernetes.io/docs/reference/kubernetes-api/common-definitions/quantity/ |
kubernetesAPIBurst int32 | Kubernetes apiserver に送信されるリクエストの最大バーストクエリ毎秒。 |
namespace 文字列 | 設定されている場合、これは cert-manager の範囲を単一の名前空間に制限し、ClusterIssuer は無効になります。指定されていない場合、すべて名前空間が監視されます。 |
clusterResourceNamespace 文字列 | ClusterIssuer など、クラスタスコープのリソースが所有するリソースを格納するための名前空間。 |
leaderElectionConfig LeaderElectionConfig | LeaderElectionConfig は、リーダー選出の動作を構成します。 |
controllers []string | 有効にするコントローラーのリスト。['*'] はすべてのコントローラーを有効にし、['foo'] は foo コントローラーのみを有効にし、['*', '-foo'] は foo という名前のコントローラーを無効にします。 |
issuerAmbientCredentials bool | 発行者が環境認証情報を使用できるかどうか。'環境認証情報'とは、Issuer API オブジェクトに明示的に構成されていない、環境、メタデータサービス、またはローカルファイルから取得された認証情報です。このフラグが有効になっている場合、次の認証情報ソースも使用されます。AWS - Go SDK がデフォルトで使用するすべてのソース、特にインスタンスメタデータから利用可能な EC2 IAM ロールを含みます。 |
clusterIssuerAmbientCredentials bool | クラスタ発行者が発行者に対して環境クレデンシャルを使用できるかどうか。'環境クレデンシャル'とは、ClusterIssuer APIオブジェクトに明示的に設定されていない環境、メタデータサービス、またはローカルファイルから取得されるクレデンシャルです。このフラグを有効にすると、以下のクレデンシャルソースも使用されます。AWS - Go SDKがデフォルトで使用するすべてのソース、特にインスタンスメタデータから利用可能なEC2 IAMロールを含みます。 |
enableCertificateOwnerRef bool | TLS証明書が保存されているシークレットの所有者として証明書リソースを設定するかどうか。このフラグを有効にすると、証明書リソースが削除されたときにシークレットが自動的に削除されます。 |
enableGatewayAPI bool | cert-manager内でGateway API統合が有効になっているかどうか。ExperimentalGatewayAPISupportフィーチャゲートも有効にする必要があります(1.15以降はデフォルト)。 |
copiedAnnotationPrefixes []string | アノテーションのキー接頭辞のリストを渡すことで、CertificateからCertificateRequestとOrderへ、およびCertificateSigningRequestからOrderへコピーするアノテーションを指定します。ダッシュ(-)で始まる接頭辞は、コピーしないアノテーションを指定します。例:’*,-kubectl.kubernetes.io/’ - 'kubectl.kubernetes.io/'で始まるキーを除くすべてのアノテーションがコピーされます。 |
numberOfConcurrentWorkers int32 | 各コントローラーの同時ワーカー数。 |
maxConcurrentChallenges int32 | 一度に'処理中'としてスケジュールできるチャレンジの最大数。 |
metricsListenAddress 文字列 | メトリクスエンドポイントがリスンするホストとポート。 |
metricsTLSConfig github.com/cert-manager/cert-manager/pkg/apis/config/shared/v1alpha1.TLSConfig | メトリクスエンドポイントのTLS設定 |
healthzListenAddress 文字列 | healthzサーバーがリスンするホストとポートアドレス(':'で区切る)。 |
enablePprof bool | コントローラーのプロファイリングを有効にする。 |
pprofAddress 文字列 | Go プロファイラーがリッスンするホストとポート(例:localhost:6060)。プロファイラーがパブリックアドレスで公開されないようにしてください。プロファイラーは /debug/pprof で提供されます。 |
logging k8s.io/component-base/logs/api/v1.LoggingConfiguration | loggingはコントローラーのロギング動作を設定します。https://pkg.go.dev/k8s.io/component-base@v0.27.3/logs/api/v1#LoggingConfiguration |
featureGates map[string]bool | (オプション) featureGates は、実験的な機能を有効または無効にするブール値への機能名のマップです。 |
ingressShimConfig IngressShimConfig | ingressShimConfigはingress-shimコントローラーの動作を設定します。 |
acmeHTTP01Config ACMEHTTP01Config | acmeHTTP01ConfigはACME HTTP01チャレンジソルバーの動作を設定します。 |
acmeDNS01Config ACMEDNS01Config | acmeDNS01ConfigはACME DNS01チャレンジソルバーの動作を設定します。 |
IngressShimConfig
(表示場所: ControllerConfiguration)
フィールド | 説明 |
---|---|
defaultIssuerName 文字列 | ingress-shimが使用するデフォルトの発行者/証明書の詳細。TLSが要求されたが、ingressリソースに発行者名が指定されていない場合に使用する発行者の名前。 |
defaultIssuerKind 文字列 | TLSが要求されたが、ingressリソースに発行者の種類が指定されていない場合に使用する発行者の種類。 |
defaultIssuerGroup 文字列 | TLSが要求されたが、ingressリソースに発行者のグループが指定されていない場合に使用する発行者のグループ。 |
defaultAutoCertificateAnnotations []string | ingress-shimコントローラーが、ingressが証明書を要求していることを示すために使用するアノテーション。 |
LeaderElectionConfig
(表示場所: ControllerConfiguration)
フィールド | 説明 |
---|---|
LeaderElectionConfig github.com/cert-manager/cert-manager/pkg/apis/config/shared/v1alpha1.LeaderElectionConfig | ( |
healthzTimeout github.com/cert-manager/cert-manager/pkg/apis/config/shared/v1alpha1.Duration | リースが期限切れになった後、このタイムアウト期間内のリーダー選出healthzチェックは依然として正常を返します。 |
meta.cert-manager.io/v1
パッケージv1は、cert-manager APIのメタタイプを含んでいます。
リソースタイプ
ConditionStatus (string
エイリアス)
(表示場所: CertificateCondition, CertificateRequestCondition, IssuerCondition)
ConditionStatusは、条件の状態を表します。
値 | 説明 |
---|---|
"False" | ConditionFalseは、特定の条件が偽であることを表します。 |
"True" | ConditionTrueは、特定の条件が真であることを表します。 |
"Unknown" | ConditionUnknownは、特定の条件が不明であることを表します。 |
LocalObjectReference
(表示場所: VenafiTPP, SecretKeySelector)
参照先と同じ名前空間にあるオブジェクトへの参照。参照先がクラスタスコープのリソース(例:ClusterIssuer)の場合、参照は代わりに、設定された'クラスタリソース名前空間'(コントローラーコンポーネントのフラグとして設定され、cert-managerが実行されている名前空間をデフォルトとする)内の指定された名前のリソースを参照します。
フィールド | 説明 |
---|---|
name 文字列 | 参照されているリソースの名前。詳細情報: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
ObjectReference
(表示場所: ChallengeSpec, OrderSpec, CertificateRequestSpec, CertificateSpec)
ObjectReferenceは、指定された名前、種類、およびグループを持つオブジェクトへの参照です。
フィールド | 説明 |
---|---|
name 文字列 | 参照されているリソースの名前。 |
kind 文字列 | (オプション) 参照されているリソースの種類。 |
group 文字列 | (オプション) 参照されているリソースのグループ。 |
SecretKeySelector
(表示場所: ACMEExternalAccountBinding, ACMEIssuer, ACMEIssuerDNS01ProviderAcmeDNS, ACMEIssuerDNS01ProviderAkamai, ACMEIssuerDNS01ProviderAzureDNS, ACMEIssuerDNS01ProviderCloudDNS, ACMEIssuerDNS01ProviderCloudflare, ACMEIssuerDNS01ProviderDigitalOcean, ACMEIssuerDNS01ProviderRFC2136, ACMEIssuerDNS01ProviderRoute53, JKSKeystore, PKCS12Keystore, VaultAppRole, VaultAuth, VaultIssuer, VaultKubernetesAuth, VenafiCloud, VenafiTPP)
Secretリソース内の特定の'キー'への参照。場合によっては、key
は必須フィールドです。
フィールド | 説明 |
---|---|
LocalObjectReference LocalObjectReference | ( 参照されているSecretリソースの名前。 |
key 文字列 | (オプション) 使用するSecretリソースの |
webhook.config.cert-manager.io/v1alpha1
パッケージv1alpha1は、Webhook設定APIのv1alpha1バージョンです。
リソースタイプ
WebhookConfiguration
フィールド | 説明 |
---|---|
securePort int32 | securePortは、kube-apiserverからの安全なTLS接続をリスンするポート番号です。0の場合、使用可能なランダムポートが選択されます。デフォルトは6443です。 |
healthzPort int32 | healthzPortは、healthz接続のために(プレーンテキストHTTPを使用して)リスンするポート番号です。0の場合、使用可能なランダムポートが選択されます。デフォルトは6080です。 |
tlsConfig github.com/cert-manager/cert-manager/pkg/apis/config/shared/v1alpha1.TLSConfig | tlsConfigは、安全なリスナーのTLS設定を構成するために使用されます。 |
kubeConfig 文字列 | kubeConfigは、Kubernetes apiserverに接続するために使用されるkubeconfigファイルです。指定されていない場合、Webhookはインクラスタ設定の読み込みを試みます。 |
apiServerHost 文字列 | apiServerHost は、API サーバーの接続アドレスをオーバーライドするために使用されます。非推奨:代わりに |
enablePprof bool | enablePprofは、pprofが有効かどうかを設定します。 |
pprofAddress 文字列 | pprofAddressは、有効な場合に/debug/pprofエンドポイントが提供されるアドレスを設定します。デフォルトは'localhost:6060'です。 |
logging k8s.io/component-base/logs/api/v1.LoggingConfiguration | loggingはWebhookのロギング動作を設定します。https://pkg.go.dev/k8s.io/component-base@v0.27.3/logs/api/v1#LoggingConfiguration |
featureGates map[string]bool | (オプション) featureGates は、実験的な機能を有効または無効にするブール値への機能名のマップです。 |
metricsListenAddress 文字列 | メトリックエンドポイントがリッスンするホストとポートです。「0」はメトリックサーバーを無効にします。デフォルトは「0.0.0.0:9402」です。 |
metricsTLSConfig github.com/cert-manager/cert-manager/pkg/apis/config/shared/v1alpha1.TLSConfig | metricsTLSConfig は、メトリックサーバーの TLS 設定を構成するために使用されます。 |
gitコミット67c897d
でgen-crd-api-reference-docs
を使用して生成されました。