Skip to content

Instantly share code, notes, and snippets.

@vincepri
Created June 21, 2019 16:16
Show Gist options
  • Save vincepri/ad6ea36dd86d8f13eec1bd50c3b363cf to your computer and use it in GitHub Desktop.
Save vincepri/ad6ea36dd86d8f13eec1bd50c3b363cf to your computer and use it in GitHub Desktop.
k describe crd (controller-tools v2 crd:trivialVersions=true)
Name: clusters.cluster.k8s.io
Namespace:
Labels: <none>
Annotations: kubectl.kubernetes.io/last-applied-configuration:
{"apiVersion":"apiextensions.k8s.io/v1beta1","kind":"CustomResourceDefinition","metadata":{"annotations":{},"creationTimestamp":null,"name...
API Version: apiextensions.k8s.io/v1beta1
Kind: CustomResourceDefinition
Metadata:
Creation Timestamp: 2019-06-21T16:15:56Z
Generation: 1
Resource Version: 431
Self Link: /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/clusters.cluster.k8s.io
UID: d943adf3-943f-11e9-a73d-0242ac110002
Spec:
Conversion:
Strategy: None
Group: cluster.k8s.io
Names:
Kind: Cluster
List Kind: ClusterList
Plural: clusters
Short Names:
cl
Singular: cluster
Scope: Namespaced
Subresources:
Status:
Validation:
Open APIV 3 Schema:
Description: / [Cluster] Cluster is the Schema for the clusters API
Properties:
API Version:
Description: 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/api-conventions.md#resources
Type: string
Kind:
Description: 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/api-conventions.md#types-kinds
Type: string
Metadata:
Properties:
Annotations:
Additional Properties:
Type: string
Description: Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations
Type: object
Cluster Name:
Description: The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.
Type: string
Creation Timestamp:
Description: CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.
Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
Format: date-time
Type: string
Deletion Grace Period Seconds:
Description: Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.
Format: int64
Type: integer
Deletion Timestamp:
Description: DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.
Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
Format: date-time
Type: string
Finalizers:
Description: Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.
Items:
Type: string
Type: array
Generate Name:
Description: GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.
If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).
Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency
Type: string
Generation:
Description: A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
Format: int64
Type: integer
Initializers:
Description: An initializer is a controller which enforces some system invariant at object creation time. This field is a list of initializers that have not yet acted on this object. If nil or empty, this object has been completely initialized. Otherwise, the object is considered uninitialized and is hidden (in list/watch and get calls) from clients that haven't explicitly asked to observe uninitialized objects.
When an object is created, the system will populate this list with the current set of initializers. Only privileged users may set or modify this list. Once it is empty, it may not be modified further by any user.
DEPRECATED - initializers are an alpha field and will be removed in v1.15.
Properties:
Pending:
Description: Pending is a list of initializers that must execute in order before this object is visible. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients.
Items:
Properties:
Name:
Description: name of the process that is responsible for initializing this object.
Type: string
Required:
name
Type: object
Type: array
Result:
Description: If result is set with the Failure field, the object will be persisted to storage and then deleted, ensuring that other clients can observe the deletion.
Properties:
API Version:
Description: 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/api-conventions.md#resources
Type: string
Code:
Description: Suggested HTTP return code for this status, 0 if not set.
Format: int32
Type: integer
Details:
Description: Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.
Properties:
Causes:
Description: The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.
Items:
Properties:
Field:
Description: The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional.
Examples: "name" - the field "name" on the current resource "items[0].name" - the field "name" on the first array entry in "items"
Type: string
Message:
Description: A human-readable description of the cause of the error. This field may be presented as-is to a reader.
Type: string
Reason:
Description: A machine-readable description of the cause of the error. If this value is empty there is no information available.
Type: string
Type: object
Type: array
Group:
Description: The group attribute of the resource associated with the status StatusReason.
Type: string
Kind:
Description: The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
Type: string
Name:
Description: The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).
Type: string
Retry After Seconds:
Description: If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action.
Format: int32
Type: integer
UID:
Description: UID of the resource. (when there is a single resource which can be described). More info: http://kubernetes.io/docs/user-guide/identifiers#uids
Type: string
Type: object
Kind:
Description: 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/api-conventions.md#types-kinds
Type: string
Message:
Description: A human-readable description of the status of this operation.
Type: string
Metadata:
Description: Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
Properties:
Continue:
Description: continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message.
Type: string
Resource Version:
Description: String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
Type: string
Self Link:
Description: selfLink is a URL representing this object. Populated by the system. Read-only.
Type: string
Type: object
Reason:
Description: A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.
Type: string
Status:
Description: Status of the operation. One of: "Success" or "Failure". More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
Type: string
Type: object
Required:
pending
Type: object
Labels:
Additional Properties:
Type: string
Description: Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
Type: object
Managed Fields:
Description: ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.
This field is alpha and can be changed or removed without notice.
Items:
Properties:
API Version:
Description: APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.
Type: string
Fields:
Additional Properties: true
Description: Fields identifies a set of fields.
Type: object
Manager:
Description: Manager is an identifier of the workflow managing these fields.
Type: string
Operation:
Description: Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.
Type: string
Time:
Description: Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'
Format: date-time
Type: string
Type: object
Type: array
Name:
Description: Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names
Type: string
Namespace:
Description: Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.
Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces
Type: string
Owner References:
Description: List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
Items:
Properties:
API Version:
Description: API version of the referent.
Type: string
Block Owner Deletion:
Description: If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.
Type: boolean
Controller:
Description: If true, this reference points to the managing controller.
Type: boolean
Kind:
Description: Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
Type: string
Name:
Description: Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names
Type: string
UID:
Description: UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
Type: string
Required:
apiVersion
kind
name
uid
Type: object
Type: array
Resource Version:
Description: An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.
Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
Type: string
Self Link:
Description: SelfLink is a URL representing this object. Populated by the system. Read-only.
Type: string
UID:
Description: UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.
Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
Type: string
Type: object
Spec:
Properties:
Cluster Network:
Description: Cluster network configuration
Properties:
Pods:
Description: The network ranges from which Pod networks are allocated.
Properties:
Cidr Blocks:
Items:
Type: string
Type: array
Required:
cidrBlocks
Type: object
Service Domain:
Description: Domain name for services.
Type: string
Services:
Description: The network ranges from which service VIPs are allocated.
Properties:
Cidr Blocks:
Items:
Type: string
Type: array
Required:
cidrBlocks
Type: object
Required:
services
pods
serviceDomain
Type: object
Provider Spec:
Description: Provider-specific serialized configuration to use during cluster creation. It is recommended that providers maintain their own versioned API types that should be serialized/deserialized from this field.
Properties:
Value:
Description: Value is an inlined, serialized representation of the resource configuration. It is recommended that providers maintain their own versioned API types that should be serialized/deserialized from this field, akin to component config.
Type: object
Value From:
Description: Source for the provider configuration. Cannot be used if value is not empty.
Properties:
Machine Class:
Description: The machine class from which the provider config should be sourced.
Properties:
API Version:
Description: API version of the referent.
Type: string
Field Path:
Description: If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future.
Type: string
Kind:
Description: Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
Type: string
Name:
Description: Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
Type: string
Namespace:
Description: Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
Type: string
Provider:
Description: Provider is the name of the cloud-provider which MachineClass is intended for.
Type: string
Resource Version:
Description: Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
Type: string
UID:
Description: UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
Type: string
Type: object
Type: object
Type: object
Required:
clusterNetwork
Type: object
Status:
Properties:
API Endpoints:
Description: APIEndpoint represents the endpoint to communicate with the IP.
Items:
Properties:
Host:
Description: The hostname on which the API server is serving.
Type: string
Port:
Description: The port on which the API server is serving.
Type: integer
Required:
host
port
Type: object
Type: array
Error Message:
Description: If set, indicates that there is a problem reconciling the state, and will be set to a descriptive error message.
Type: string
Error Reason:
Description: If set, indicates that there is a problem reconciling the state, and will be set to a token value suitable for programmatic interpretation.
Type: string
Provider Status:
Description: Provider-specific status. It is recommended that providers maintain their own versioned API types that should be serialized/deserialized from this field.
Type: object
Type: object
Type: object
Version: v1alpha1
Versions:
Name: v1alpha1
Served: true
Storage: true
Status:
Accepted Names:
Kind: Cluster
List Kind: ClusterList
Plural: clusters
Short Names:
cl
Singular: cluster
Conditions:
Last Transition Time: 2019-06-21T16:15:56Z
Message: no conflicts found
Reason: NoConflicts
Status: True
Type: NamesAccepted
Last Transition Time: <nil>
Message: the initial names have been accepted
Reason: InitialNamesAccepted
Status: True
Type: Established
Stored Versions:
v1alpha1
Events: <none>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment