Bug 1880853
| Summary: | OperatorPKI has no description in `oc explain` output | ||
|---|---|---|---|
| Product: | OpenShift Container Platform | Reporter: | Jason Boxman <jboxman> |
| Component: | Networking | Assignee: | Juan Luis de Sousa-Valadas <jdesousa> |
| Networking sub component: | openshift-sdn | QA Contact: | zhaozhanqi <zzhao> |
| Status: | CLOSED ERRATA | Docs Contact: | |
| Severity: | medium | ||
| Priority: | unspecified | CC: | aconstan |
| Version: | 4.6 | ||
| Target Milestone: | --- | ||
| Target Release: | 4.6.0 | ||
| Hardware: | Unspecified | ||
| OS: | Unspecified | ||
| Whiteboard: | |||
| Fixed In Version: | Doc Type: | If docs needed, set a value | |
| Doc Text: | Story Points: | --- | |
| Clone Of: | Environment: | ||
| Last Closed: | 2020-10-27 16:42:58 UTC | Type: | Bug |
| Regression: | --- | Mount Type: | --- |
| Documentation: | --- | CRM: | |
| Verified Versions: | Category: | --- | |
| oVirt Team: | --- | RHEL 7.3 requirements from Atomic Host: | |
| Cloudforms Team: | --- | Target Upstream Version: | |
| Embargoed: | |||
Verified this bug on 4.6.0-0.nightly-2020-09-23-022756
oc explain OperatorPKI
KIND: OperatorPKI
VERSION: network.operator.openshift.io/v1
DESCRIPTION:
OperatorPKI is a simple certificate authority. It is not intended for
external use - rather, it is internal to the network operator. The CNO
creates a CA and a certificate signed by that CA. The certificate has both
ClientAuth and ServerAuth extended usages enabled. More specifically, given
an OperatorPKI with <name>, the CNO will manage: - A Secret called
<name>-ca with two data keys: - tls.key - the private key - tls.crt - the
CA certificate - A ConfigMap called <name>-ca with a single data key: -
cabundle.crt - the CA certificate(s) - A Secret called <name>-cert with two
data keys: - tls.key - the private key - tls.crt - the certificate, signed
by the CA The CA certificate will have a validity of 10 years, rotated
after 9. The target certificate will have a validity of 6 months, rotated
after 3 The CA certificate will have a CommonName of
"<namespace>_<name>-ca@<timestamp>", where <timestamp> is the last rotation
time.
FIELDS:
apiVersion <string>
APIVersion defines the versioned schema of this representation of an
object. Servers should convert recognized schemas to the latest internal
value, and may reject unrecognized values. More info:
https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
kind <string>
Kind is a string value representing the REST resource this object
represents. Servers may infer this from the endpoint the client submits
requests to. Cannot be updated. In CamelCase. More info:
https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metadata <Object>
Standard object's metadata. More info:
https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
spec <Object> -required-
OperatorPKISpec is the PKI configuration.
status <map[string]>
OperatorPKIStatus is not implemented.
Since the problem described in this bug report should be resolved in a recent advisory, it has been closed with a resolution of ERRATA. For information on the advisory (OpenShift Container Platform 4.6 GA Images), and where to find the updated files, follow the link below. If the solution does not work for you, open a new bug report. https://access.redhat.com/errata/RHBA-2020:4196 |
Description of problem: I'm not actually sure if OperatorPKI should be exposed to users? But it appears in `oc api-resources` output, and each CRD in that output ideally provides API information when a user enters `oc explain <CRD>`. How reproducible: Always. Steps to Reproduce: `oc explain OperatorPKI` Actual results: KIND: OperatorPKI VERSION: network.operator.openshift.io/v1 DESCRIPTION: <empty> Expected results: A description of what this CRD is for. Additional info: I haven't gotten the impression that this CRD is relevant to a user; Is it possible to remove it from the list of advertised APIs? To date, I've only seen `Network.operator` and `Network.config` as user-facing. I'm unfamiliar with the OperatorPKI CRD. (I'm not sure what is the proper sub-component for this BZ.)