From febd4de9afe8606160346aabde9441145d906897 Mon Sep 17 00:00:00 2001 From: Ming Fang Date: Tue, 11 Aug 2020 21:32:05 -0400 Subject: [PATCH] regenerate docs --- .../k8s_extensions_v1beta1_ingress/README.md | 385 ------------------ .../README.md | 140 ------- .../README.md | 140 ------- .../README.md | 188 --------- .../README.md | 118 ------ ...s_io_v1_mutating_webhook_configuration.md} | 0 ...io_v1_validating_webhook_configuration.md} | 0 ...v1beta1_mutating_webhook_configuration.md} | 0 ...beta1_validating_webhook_configuration.md} | 0 ...s_k8s_io_v1_custom_resource_definition.md} | 0 ..._io_v1beta1_custom_resource_definition.md} | 0 .../apiregistration_k8s_io_v1_api_service.md} | 0 ...egistration_k8s_io_v1beta1_api_service.md} | 0 .../apps_v1_daemon_set.md} | 0 .../apps_v1_deployment.md} | 0 .../apps_v1_replica_set.md} | 0 .../apps_v1_stateful_set.md} | 0 ...egistration_k8s_io_v1alpha1_audit_sink.md} | 0 ...toscaling_v1_horizontal_pod_autoscaler.md} | 0 ...ling_v2beta1_horizontal_pod_autoscaler.md} | 0 ...ling_v2beta2_horizontal_pod_autoscaler.md} | 0 .../README.md => resources/batch_v1_job.md} | 0 .../batch_v1beta1_cron_job.md} | 0 .../batch_v2alpha1_cron_job.md} | 0 .../core_v1_config_map.md} | 0 .../core_v1_endpoints.md} | 0 .../core_v1_limit_range.md} | 0 .../core_v1_namespace.md} | 0 .../core_v1_persistent_volume.md} | 0 .../core_v1_persistent_volume_claim.md} | 0 .../README.md => resources/core_v1_pod.md} | 0 .../core_v1_pod_template.md} | 0 .../core_v1_replication_controller.md} | 0 .../core_v1_resource_quota.md} | 0 .../README.md => resources/core_v1_secret.md} | 0 .../core_v1_service.md} | 0 .../core_v1_service_account.md} | 0 ...iscovery_k8s_io_v1beta1_endpoint_slice.md} | 0 ..._apiserver_k8s_io_v1alpha1_flow_schema.md} | 0 ..._v1alpha1_priority_level_configuration.md} | 0 .../networking_k8s_io_v1_network_policy.md} | 0 .../networking_k8s_io_v1beta1_ingress.md} | 0 ...etworking_k8s_io_v1beta1_ingress_class.md} | 0 .../node_k8s_io_v1alpha1_runtime_class.md} | 0 .../node_k8s_io_v1beta1_runtime_class.md} | 0 .../policy_v1beta1_pod_disruption_budget.md} | 0 .../policy_v1beta1_pod_security_policy.md} | 0 ...c_authorization_k8s_io_v1_cluster_role.md} | 0 ...ization_k8s_io_v1_cluster_role_binding.md} | 0 .../rbac_authorization_k8s_io_v1_role.md} | 0 ...c_authorization_k8s_io_v1_role_binding.md} | 0 ...orization_k8s_io_v1alpha1_cluster_role.md} | 0 ...n_k8s_io_v1alpha1_cluster_role_binding.md} | 0 ...bac_authorization_k8s_io_v1alpha1_role.md} | 0 ...orization_k8s_io_v1alpha1_role_binding.md} | 0 ...horization_k8s_io_v1beta1_cluster_role.md} | 0 ...on_k8s_io_v1beta1_cluster_role_binding.md} | 0 ...rbac_authorization_k8s_io_v1beta1_role.md} | 0 ...horization_k8s_io_v1beta1_role_binding.md} | 0 .../scheduling_k8s_io_v1_priority_class.md} | 0 .../settings_k8s_io_v1alpha1_pod_preset.md} | 0 .../storage_k8s_io_v1_csi_driver.md} | 0 .../storage_k8s_io_v1_csi_node.md} | 0 .../storage_k8s_io_v1_storage_class.md} | 0 .../storage_k8s_io_v1_volume_attachment.md} | 0 ...rage_k8s_io_v1alpha1_volume_attachment.md} | 0 .../storage_k8s_io_v1beta1_csi_driver.md} | 0 .../storage_k8s_io_v1beta1_storage_class.md} | 0 ...orage_k8s_io_v1beta1_volume_attachment.md} | 0 69 files changed, 971 deletions(-) delete mode 100755 docs/DEPRECATED/k8s_extensions_v1beta1_ingress/README.md delete mode 100755 docs/DEPRECATED/k8s_scheduling_k8s_io_v1alpha1_priority_class/README.md delete mode 100755 docs/DEPRECATED/k8s_scheduling_k8s_io_v1beta1_priority_class/README.md delete mode 100755 docs/DEPRECATED/k8s_storage_k8s_io_v1beta1_csi_node/README.md delete mode 100755 docs/k8s_config_gatekeeper_sh_v1alpha1_config/README.md rename docs/{k8s_admissionregistration_k8s_io_v1_mutating_webhook_configuration/README.md => resources/admissionregistration_k8s_io_v1_mutating_webhook_configuration.md} (100%) rename docs/{k8s_admissionregistration_k8s_io_v1_validating_webhook_configuration/README.md => resources/admissionregistration_k8s_io_v1_validating_webhook_configuration.md} (100%) rename docs/{k8s_admissionregistration_k8s_io_v1beta1_mutating_webhook_configuration/README.md => resources/admissionregistration_k8s_io_v1beta1_mutating_webhook_configuration.md} (100%) rename docs/{k8s_admissionregistration_k8s_io_v1beta1_validating_webhook_configuration/README.md => resources/admissionregistration_k8s_io_v1beta1_validating_webhook_configuration.md} (100%) rename docs/{k8s_apiextensions_k8s_io_v1_custom_resource_definition/README.md => resources/apiextensions_k8s_io_v1_custom_resource_definition.md} (100%) rename docs/{k8s_apiextensions_k8s_io_v1beta1_custom_resource_definition/README.md => resources/apiextensions_k8s_io_v1beta1_custom_resource_definition.md} (100%) rename docs/{k8s_apiregistration_k8s_io_v1_api_service/README.md => resources/apiregistration_k8s_io_v1_api_service.md} (100%) rename docs/{k8s_apiregistration_k8s_io_v1beta1_api_service/README.md => resources/apiregistration_k8s_io_v1beta1_api_service.md} (100%) rename docs/{k8s_apps_v1_daemon_set/README.md => resources/apps_v1_daemon_set.md} (100%) rename docs/{k8s_apps_v1_deployment/README.md => resources/apps_v1_deployment.md} (100%) rename docs/{k8s_apps_v1_replica_set/README.md => resources/apps_v1_replica_set.md} (100%) rename docs/{k8s_apps_v1_stateful_set/README.md => resources/apps_v1_stateful_set.md} (100%) rename docs/{k8s_auditregistration_k8s_io_v1alpha1_audit_sink/README.md => resources/auditregistration_k8s_io_v1alpha1_audit_sink.md} (100%) rename docs/{k8s_autoscaling_v1_horizontal_pod_autoscaler/README.md => resources/autoscaling_v1_horizontal_pod_autoscaler.md} (100%) rename docs/{k8s_autoscaling_v2beta1_horizontal_pod_autoscaler/README.md => resources/autoscaling_v2beta1_horizontal_pod_autoscaler.md} (100%) rename docs/{k8s_autoscaling_v2beta2_horizontal_pod_autoscaler/README.md => resources/autoscaling_v2beta2_horizontal_pod_autoscaler.md} (100%) rename docs/{k8s_batch_v1_job/README.md => resources/batch_v1_job.md} (100%) rename docs/{k8s_batch_v1beta1_cron_job/README.md => resources/batch_v1beta1_cron_job.md} (100%) rename docs/{k8s_batch_v2alpha1_cron_job/README.md => resources/batch_v2alpha1_cron_job.md} (100%) rename docs/{k8s_core_v1_config_map/README.md => resources/core_v1_config_map.md} (100%) rename docs/{k8s_core_v1_endpoints/README.md => resources/core_v1_endpoints.md} (100%) rename docs/{k8s_core_v1_limit_range/README.md => resources/core_v1_limit_range.md} (100%) rename docs/{k8s_core_v1_namespace/README.md => resources/core_v1_namespace.md} (100%) rename docs/{k8s_core_v1_persistent_volume/README.md => resources/core_v1_persistent_volume.md} (100%) rename docs/{k8s_core_v1_persistent_volume_claim/README.md => resources/core_v1_persistent_volume_claim.md} (100%) rename docs/{k8s_core_v1_pod/README.md => resources/core_v1_pod.md} (100%) rename docs/{k8s_core_v1_pod_template/README.md => resources/core_v1_pod_template.md} (100%) rename docs/{k8s_core_v1_replication_controller/README.md => resources/core_v1_replication_controller.md} (100%) rename docs/{k8s_core_v1_resource_quota/README.md => resources/core_v1_resource_quota.md} (100%) rename docs/{k8s_core_v1_secret/README.md => resources/core_v1_secret.md} (100%) rename docs/{k8s_core_v1_service/README.md => resources/core_v1_service.md} (100%) rename docs/{k8s_core_v1_service_account/README.md => resources/core_v1_service_account.md} (100%) rename docs/{k8s_discovery_k8s_io_v1beta1_endpoint_slice/README.md => resources/discovery_k8s_io_v1beta1_endpoint_slice.md} (100%) rename docs/{k8s_flowcontrol_apiserver_k8s_io_v1alpha1_flow_schema/README.md => resources/flowcontrol_apiserver_k8s_io_v1alpha1_flow_schema.md} (100%) rename docs/{k8s_flowcontrol_apiserver_k8s_io_v1alpha1_priority_level_configuration/README.md => resources/flowcontrol_apiserver_k8s_io_v1alpha1_priority_level_configuration.md} (100%) rename docs/{k8s_networking_k8s_io_v1_network_policy/README.md => resources/networking_k8s_io_v1_network_policy.md} (100%) rename docs/{k8s_networking_k8s_io_v1beta1_ingress/README.md => resources/networking_k8s_io_v1beta1_ingress.md} (100%) rename docs/{k8s_networking_k8s_io_v1beta1_ingress_class/README.md => resources/networking_k8s_io_v1beta1_ingress_class.md} (100%) rename docs/{k8s_node_k8s_io_v1alpha1_runtime_class/README.md => resources/node_k8s_io_v1alpha1_runtime_class.md} (100%) rename docs/{k8s_node_k8s_io_v1beta1_runtime_class/README.md => resources/node_k8s_io_v1beta1_runtime_class.md} (100%) rename docs/{k8s_policy_v1beta1_pod_disruption_budget/README.md => resources/policy_v1beta1_pod_disruption_budget.md} (100%) rename docs/{k8s_policy_v1beta1_pod_security_policy/README.md => resources/policy_v1beta1_pod_security_policy.md} (100%) rename docs/{k8s_rbac_authorization_k8s_io_v1_cluster_role/README.md => resources/rbac_authorization_k8s_io_v1_cluster_role.md} (100%) rename docs/{k8s_rbac_authorization_k8s_io_v1_cluster_role_binding/README.md => resources/rbac_authorization_k8s_io_v1_cluster_role_binding.md} (100%) rename docs/{k8s_rbac_authorization_k8s_io_v1_role/README.md => resources/rbac_authorization_k8s_io_v1_role.md} (100%) rename docs/{k8s_rbac_authorization_k8s_io_v1_role_binding/README.md => resources/rbac_authorization_k8s_io_v1_role_binding.md} (100%) rename docs/{k8s_rbac_authorization_k8s_io_v1alpha1_cluster_role/README.md => resources/rbac_authorization_k8s_io_v1alpha1_cluster_role.md} (100%) rename docs/{k8s_rbac_authorization_k8s_io_v1alpha1_cluster_role_binding/README.md => resources/rbac_authorization_k8s_io_v1alpha1_cluster_role_binding.md} (100%) rename docs/{k8s_rbac_authorization_k8s_io_v1alpha1_role/README.md => resources/rbac_authorization_k8s_io_v1alpha1_role.md} (100%) rename docs/{k8s_rbac_authorization_k8s_io_v1alpha1_role_binding/README.md => resources/rbac_authorization_k8s_io_v1alpha1_role_binding.md} (100%) rename docs/{k8s_rbac_authorization_k8s_io_v1beta1_cluster_role/README.md => resources/rbac_authorization_k8s_io_v1beta1_cluster_role.md} (100%) rename docs/{k8s_rbac_authorization_k8s_io_v1beta1_cluster_role_binding/README.md => resources/rbac_authorization_k8s_io_v1beta1_cluster_role_binding.md} (100%) rename docs/{k8s_rbac_authorization_k8s_io_v1beta1_role/README.md => resources/rbac_authorization_k8s_io_v1beta1_role.md} (100%) rename docs/{k8s_rbac_authorization_k8s_io_v1beta1_role_binding/README.md => resources/rbac_authorization_k8s_io_v1beta1_role_binding.md} (100%) rename docs/{k8s_scheduling_k8s_io_v1_priority_class/README.md => resources/scheduling_k8s_io_v1_priority_class.md} (100%) rename docs/{k8s_settings_k8s_io_v1alpha1_pod_preset/README.md => resources/settings_k8s_io_v1alpha1_pod_preset.md} (100%) rename docs/{k8s_storage_k8s_io_v1_csi_driver/README.md => resources/storage_k8s_io_v1_csi_driver.md} (100%) rename docs/{k8s_storage_k8s_io_v1_csi_node/README.md => resources/storage_k8s_io_v1_csi_node.md} (100%) rename docs/{k8s_storage_k8s_io_v1_storage_class/README.md => resources/storage_k8s_io_v1_storage_class.md} (100%) rename docs/{k8s_storage_k8s_io_v1_volume_attachment/README.md => resources/storage_k8s_io_v1_volume_attachment.md} (100%) rename docs/{k8s_storage_k8s_io_v1alpha1_volume_attachment/README.md => resources/storage_k8s_io_v1alpha1_volume_attachment.md} (100%) rename docs/{k8s_storage_k8s_io_v1beta1_csi_driver/README.md => resources/storage_k8s_io_v1beta1_csi_driver.md} (100%) rename docs/{k8s_storage_k8s_io_v1beta1_storage_class/README.md => resources/storage_k8s_io_v1beta1_storage_class.md} (100%) rename docs/{k8s_storage_k8s_io_v1beta1_volume_attachment/README.md => resources/storage_k8s_io_v1beta1_volume_attachment.md} (100%) diff --git a/docs/DEPRECATED/k8s_extensions_v1beta1_ingress/README.md b/docs/DEPRECATED/k8s_extensions_v1beta1_ingress/README.md deleted file mode 100755 index 0294219..0000000 --- a/docs/DEPRECATED/k8s_extensions_v1beta1_ingress/README.md +++ /dev/null @@ -1,385 +0,0 @@ - -# resource "k8s_extensions_v1beta1_ingress" - -Ingress is a collection of rules that allow inbound connections to reach the endpoints defined by a backend. An Ingress can be configured to give services externally-reachable urls, load balance traffic, terminate SSL, offer name based virtual hosting etc. DEPRECATED - This group version of Ingress is deprecated by networking.k8s.io/v1beta1 Ingress. See the release notes for more information. - - -
-metadata
- - -- [annotations](#annotations) -- [creation_timestamp](#creation_timestamp) -- [deletion_grace_period_seconds](#deletion_grace_period_seconds) -- [deletion_timestamp](#deletion_timestamp) -- [labels](#labels) -- [name](#name) -- [namespace](#namespace) -- [resource_version](#resource_version) -- [self_link](#self_link) -- [uid](#uid) - - -
- -
-spec
- - -- [ingress_class_name](#ingress_class_name) - - -
-backend
- - -- [service_name](#service_name) -- [service_port](#service_port) - - -
-resource
- - -- [api_group](#api_group) -- [kind](#kind)* -- [name](#name)* - - -
- -
- -
-rules
- - -- [host](#host) - - -
-http
- - - - -
-paths
- - -- [path](#path) -- [path_type](#path_type) - - -
-backend
- - -- [service_name](#service_name) -- [service_port](#service_port) - - -
-resource
- - -- [api_group](#api_group) -- [kind](#kind)* -- [name](#name)* - - -
- -
- -
- -
- -
- -
-tls
- - -- [hosts](#hosts) -- [secret_name](#secret_name) - - -
- -
- - -
-example
- -```hcl -resource "k8s_extensions_v1beta1_ingress" "this" { - - metadata { - annotations = { "key" = "TypeString" } - labels = { "key" = "TypeString" } - name = "TypeString" - namespace = "TypeString" - } - - spec { - - backend { - - resource { - api_group = "TypeString" - kind = "TypeString*" - name = "TypeString*" - } - service_name = "TypeString" - service_port = "TypeString" - } - ingress_class_name = "TypeString" - - rules { - host = "TypeString" - - http { - - paths { - - backend { - - resource { - api_group = "TypeString" - kind = "TypeString*" - name = "TypeString*" - } - service_name = "TypeString" - service_port = "TypeString" - } - path = "TypeString" - path_type = "TypeString" - } - } - } - - tls { - hosts = ["TypeString"] - secret_name = "TypeString" - } - } -} - - -``` - -
- - -## metadata - -Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - - -#### annotations - -###### TypeMap - -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 -#### creation_timestamp - -###### ReadOnly • TypeString - -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/sig-architecture/api-conventions.md#metadata -#### deletion_grace_period_seconds - -###### ReadOnly • TypeInt - -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. -#### deletion_timestamp - -###### ReadOnly • TypeString - -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/sig-architecture/api-conventions.md#metadata -#### labels - -###### TypeMap - -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 -#### name - -###### TypeString - -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 -#### namespace - -###### TypeString - -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 -#### resource_version - -###### ReadOnly • TypeString - -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/sig-architecture/api-conventions.md#concurrency-control-and-consistency -#### self_link - -###### ReadOnly • TypeString - -SelfLink is a URL representing this object. Populated by the system. Read-only. - -DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release. -#### uid - -###### ReadOnly • TypeString - -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 -## spec - -Spec is the desired state of the Ingress. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status - - -## backend - -A default backend capable of servicing requests that don't match any rule. At least one of 'backend' or 'rules' must be specified. This field is optional to allow the loadbalancer controller or defaulting logic to specify a global default. - - -## resource - -Resource is an ObjectRef to another Kubernetes resource in the namespace of the Ingress object. If resource is specified, serviceName and servicePort must not be specified. - - -#### api_group - -###### TypeString - -APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. -#### kind - -###### Required • TypeString - -Kind is the type of resource being referenced -#### name - -###### Required • TypeString - -Name is the name of resource being referenced -#### service_name - -###### TypeString - -Specifies the name of the referenced service. -#### service_port - -###### TypeString - -Specifies the port of the referenced service. -#### ingress_class_name - -###### TypeString - -IngressClassName is the name of the IngressClass cluster resource. The associated IngressClass defines which controller will implement the resource. This replaces the deprecated `kubernetes.io/ingress.class` annotation. For backwards compatibility, when that annotation is set, it must be given precedence over this field. The controller may emit a warning if the field and annotation have different values. Implementations of this API should ignore Ingresses without a class specified. An IngressClass resource may be marked as default, which can be used to set a default value for this field. For more information, refer to the IngressClass documentation. -## rules - -A list of host rules used to configure the Ingress. If unspecified, or no rule matches, all traffic is sent to the default backend. - - -#### host - -###### TypeString - -Host is the fully qualified domain name of a network host, as defined by RFC 3986. Note the following deviations from the "host" part of the URI as defined in RFC 3986: 1. IPs are not allowed. Currently an IngressRuleValue can only apply to - the IP in the Spec of the parent Ingress. -2. The `:` delimiter is not respected because ports are not allowed. - Currently the port of an Ingress is implicitly :80 for http and - :443 for https. -Both these may change in the future. Incoming requests are matched against the host before the IngressRuleValue. If the host is unspecified, the Ingress routes all traffic based on the specified IngressRuleValue. - -Host can be "precise" which is a domain name without the terminating dot of a network host (e.g. "foo.bar.com") or "wildcard", which is a domain name prefixed with a single wildcard label (e.g. "*.foo.com"). The wildcard character '*' must appear by itself as the first DNS label and matches only a single label. You cannot have a wildcard label by itself (e.g. Host == "*"). Requests will be matched against the Host field in the following way: 1. If Host is precise, the request matches this rule if the http host header is equal to Host. 2. If Host is a wildcard, then the request matches this rule if the http host header is to equal to the suffix (removing the first label) of the wildcard rule. -## http - - - - -## paths - -A collection of paths that map requests to backends. - - -## backend - -Backend defines the referenced service endpoint to which the traffic will be forwarded to. - - -## resource - -Resource is an ObjectRef to another Kubernetes resource in the namespace of the Ingress object. If resource is specified, serviceName and servicePort must not be specified. - - -#### api_group - -###### TypeString - -APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. -#### kind - -###### Required • TypeString - -Kind is the type of resource being referenced -#### name - -###### Required • TypeString - -Name is the name of resource being referenced -#### service_name - -###### TypeString - -Specifies the name of the referenced service. -#### service_port - -###### TypeString - -Specifies the port of the referenced service. -#### path - -###### TypeString - -Path is matched against the path of an incoming request. Currently it can contain characters disallowed from the conventional "path" part of a URL as defined by RFC 3986. Paths must begin with a '/'. When unspecified, all paths from incoming requests are matched. -#### path_type - -###### TypeString - -PathType determines the interpretation of the Path matching. PathType can be one of the following values: * Exact: Matches the URL path exactly. * Prefix: Matches based on a URL path prefix split by '/'. Matching is - done on a path element by element basis. A path element refers is the - list of labels in the path split by the '/' separator. A request is a - match for path p if every p is an element-wise prefix of p of the - request path. Note that if the last element of the path is a substring - of the last element in request path, it is not a match (e.g. /foo/bar - matches /foo/bar/baz, but does not match /foo/barbaz). -* ImplementationSpecific: Interpretation of the Path matching is up to - the IngressClass. Implementations can treat this as a separate PathType - or treat it identically to Prefix or Exact path types. -Implementations are required to support all path types. Defaults to ImplementationSpecific. -## tls - -TLS configuration. Currently the Ingress only supports a single TLS port, 443. If multiple members of this list specify different hosts, they will be multiplexed on the same port according to the hostname specified through the SNI TLS extension, if the ingress controller fulfilling the ingress supports SNI. - - -#### hosts - -###### TypeList - -Hosts are a list of hosts included in the TLS certificate. The values in this list must match the name/s used in the tlsSecret. Defaults to the wildcard host setting for the loadbalancer controller fulfilling this Ingress, if left unspecified. -#### secret_name - -###### TypeString - -SecretName is the name of the secret used to terminate SSL traffic on 443. Field is left optional to allow SSL routing based on SNI hostname alone. If the SNI host in a listener conflicts with the "Host" header field used by an IngressRule, the SNI host is used for termination and value of the Host header is used for routing. \ No newline at end of file diff --git a/docs/DEPRECATED/k8s_scheduling_k8s_io_v1alpha1_priority_class/README.md b/docs/DEPRECATED/k8s_scheduling_k8s_io_v1alpha1_priority_class/README.md deleted file mode 100755 index 3fd8517..0000000 --- a/docs/DEPRECATED/k8s_scheduling_k8s_io_v1alpha1_priority_class/README.md +++ /dev/null @@ -1,140 +0,0 @@ - -# resource "k8s_scheduling_k8s_io_v1alpha1_priority_class" - -DEPRECATED - This group version of PriorityClass is deprecated by scheduling.k8s.io/v1/PriorityClass. PriorityClass defines mapping from a priority class name to the priority integer value. The value can be any valid integer. - - -
-metadata
- - -- [annotations](#annotations) -- [creation_timestamp](#creation_timestamp) -- [deletion_grace_period_seconds](#deletion_grace_period_seconds) -- [deletion_timestamp](#deletion_timestamp) -- [labels](#labels) -- [name](#name) -- [namespace](#namespace) -- [resource_version](#resource_version) -- [self_link](#self_link) -- [uid](#uid) - - -
- - -
-example
- -```hcl -resource "k8s_scheduling_k8s_io_v1alpha1_priority_class" "this" { - - description = "TypeString" - - global_default = "TypeString" - - metadata { - annotations = { "key" = "TypeString" } - labels = { "key" = "TypeString" } - name = "TypeString" - namespace = "TypeString" - } - - preemption_policy = "TypeString" - - value = "TypeInt*" -} - - -``` - -
- - -#### description - -###### TypeString - -description is an arbitrary string that usually provides guidelines on when this priority class should be used. -#### global_default - -###### TypeString - -globalDefault specifies whether this PriorityClass should be considered as the default priority for pods that do not have any priority class. Only one PriorityClass can be marked as `globalDefault`. However, if more than one PriorityClasses exists with their `globalDefault` field set to true, the smallest value of such global default PriorityClasses will be used as the default priority. -## metadata - -Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - - -#### annotations - -###### TypeMap - -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 -#### creation_timestamp - -###### ReadOnly • TypeString - -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/sig-architecture/api-conventions.md#metadata -#### deletion_grace_period_seconds - -###### ReadOnly • TypeInt - -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. -#### deletion_timestamp - -###### ReadOnly • TypeString - -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/sig-architecture/api-conventions.md#metadata -#### labels - -###### TypeMap - -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 -#### name - -###### TypeString - -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 -#### namespace - -###### TypeString - -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 -#### resource_version - -###### ReadOnly • TypeString - -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/sig-architecture/api-conventions.md#concurrency-control-and-consistency -#### self_link - -###### ReadOnly • TypeString - -SelfLink is a URL representing this object. Populated by the system. Read-only. - -DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release. -#### uid - -###### ReadOnly • TypeString - -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 -#### preemption_policy - -###### TypeString - -PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is alpha-level and is only honored by servers that enable the NonPreemptingPriority feature. -#### value - -###### Required • TypeInt - -The value of this priority class. This is the actual priority that pods receive when they have the name of this class in their pod spec. \ No newline at end of file diff --git a/docs/DEPRECATED/k8s_scheduling_k8s_io_v1beta1_priority_class/README.md b/docs/DEPRECATED/k8s_scheduling_k8s_io_v1beta1_priority_class/README.md deleted file mode 100755 index 4e54a99..0000000 --- a/docs/DEPRECATED/k8s_scheduling_k8s_io_v1beta1_priority_class/README.md +++ /dev/null @@ -1,140 +0,0 @@ - -# resource "k8s_scheduling_k8s_io_v1beta1_priority_class" - -DEPRECATED - This group version of PriorityClass is deprecated by scheduling.k8s.io/v1/PriorityClass. PriorityClass defines mapping from a priority class name to the priority integer value. The value can be any valid integer. - - -
-metadata
- - -- [annotations](#annotations) -- [creation_timestamp](#creation_timestamp) -- [deletion_grace_period_seconds](#deletion_grace_period_seconds) -- [deletion_timestamp](#deletion_timestamp) -- [labels](#labels) -- [name](#name) -- [namespace](#namespace) -- [resource_version](#resource_version) -- [self_link](#self_link) -- [uid](#uid) - - -
- - -
-example
- -```hcl -resource "k8s_scheduling_k8s_io_v1beta1_priority_class" "this" { - - description = "TypeString" - - global_default = "TypeString" - - metadata { - annotations = { "key" = "TypeString" } - labels = { "key" = "TypeString" } - name = "TypeString" - namespace = "TypeString" - } - - preemption_policy = "TypeString" - - value = "TypeInt*" -} - - -``` - -
- - -#### description - -###### TypeString - -description is an arbitrary string that usually provides guidelines on when this priority class should be used. -#### global_default - -###### TypeString - -globalDefault specifies whether this PriorityClass should be considered as the default priority for pods that do not have any priority class. Only one PriorityClass can be marked as `globalDefault`. However, if more than one PriorityClasses exists with their `globalDefault` field set to true, the smallest value of such global default PriorityClasses will be used as the default priority. -## metadata - -Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - - -#### annotations - -###### TypeMap - -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 -#### creation_timestamp - -###### ReadOnly • TypeString - -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/sig-architecture/api-conventions.md#metadata -#### deletion_grace_period_seconds - -###### ReadOnly • TypeInt - -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. -#### deletion_timestamp - -###### ReadOnly • TypeString - -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/sig-architecture/api-conventions.md#metadata -#### labels - -###### TypeMap - -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 -#### name - -###### TypeString - -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 -#### namespace - -###### TypeString - -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 -#### resource_version - -###### ReadOnly • TypeString - -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/sig-architecture/api-conventions.md#concurrency-control-and-consistency -#### self_link - -###### ReadOnly • TypeString - -SelfLink is a URL representing this object. Populated by the system. Read-only. - -DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release. -#### uid - -###### ReadOnly • TypeString - -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 -#### preemption_policy - -###### TypeString - -PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is alpha-level and is only honored by servers that enable the NonPreemptingPriority feature. -#### value - -###### Required • TypeInt - -The value of this priority class. This is the actual priority that pods receive when they have the name of this class in their pod spec. \ No newline at end of file diff --git a/docs/DEPRECATED/k8s_storage_k8s_io_v1beta1_csi_node/README.md b/docs/DEPRECATED/k8s_storage_k8s_io_v1beta1_csi_node/README.md deleted file mode 100755 index 4180136..0000000 --- a/docs/DEPRECATED/k8s_storage_k8s_io_v1beta1_csi_node/README.md +++ /dev/null @@ -1,188 +0,0 @@ - -# resource "k8s_storage_k8s_io_v1beta1_csi_node" - -DEPRECATED - This group version of CSINode is deprecated by storage/v1/CSINode. See the release notes for more information. CSINode holds information about all CSI drivers installed on a node. CSI drivers do not need to create the CSINode object directly. As long as they use the node-driver-registrar sidecar container, the kubelet will automatically populate the CSINode object for the CSI driver as part of kubelet plugin registration. CSINode has the same name as a node. If the object is missing, it means either there are no CSI Drivers available on the node, or the Kubelet version is low enough that it doesn't create this object. CSINode has an OwnerReference that points to the corresponding node object. - - -
-metadata
- - -- [annotations](#annotations) -- [creation_timestamp](#creation_timestamp) -- [deletion_grace_period_seconds](#deletion_grace_period_seconds) -- [deletion_timestamp](#deletion_timestamp) -- [labels](#labels) -- [name](#name) -- [namespace](#namespace) -- [resource_version](#resource_version) -- [self_link](#self_link) -- [uid](#uid) - - -
- -
-spec
- - - - -
-drivers
- - -- [name](#name)* -- [node_id](#node_id)* -- [topology_keys](#topology_keys) - - -
-allocatable
- - -- [count](#count) - - -
- -
- -
- - -
-example
- -```hcl -resource "k8s_storage_k8s_io_v1beta1_csi_node" "this" { - - metadata { - annotations = { "key" = "TypeString" } - labels = { "key" = "TypeString" } - name = "TypeString" - namespace = "TypeString" - } - - spec { - - drivers { - - allocatable { - count = "TypeInt" - } - name = "TypeString*" - node_id = "TypeString*" - topology_keys = ["TypeString"] - } - } -} - - -``` - -
- - -## metadata - -metadata.name must be the Kubernetes node name. - - -#### annotations - -###### TypeMap - -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 -#### creation_timestamp - -###### ReadOnly • TypeString - -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/sig-architecture/api-conventions.md#metadata -#### deletion_grace_period_seconds - -###### ReadOnly • TypeInt - -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. -#### deletion_timestamp - -###### ReadOnly • TypeString - -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/sig-architecture/api-conventions.md#metadata -#### labels - -###### TypeMap - -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 -#### name - -###### TypeString - -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 -#### namespace - -###### TypeString - -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 -#### resource_version - -###### ReadOnly • TypeString - -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/sig-architecture/api-conventions.md#concurrency-control-and-consistency -#### self_link - -###### ReadOnly • TypeString - -SelfLink is a URL representing this object. Populated by the system. Read-only. - -DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release. -#### uid - -###### ReadOnly • TypeString - -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 -## spec - -spec is the specification of CSINode - - -## drivers - -drivers is a list of information of all CSI Drivers existing on a node. If all drivers in the list are uninstalled, this can become empty. - - -## allocatable - -allocatable represents the volume resources of a node that are available for scheduling. - - -#### count - -###### TypeInt - -Maximum number of unique volumes managed by the CSI driver that can be used on a node. A volume that is both attached and mounted on a node is considered to be used once, not twice. The same rule applies for a unique volume that is shared among multiple pods on the same node. If this field is nil, then the supported number of volumes on this node is unbounded. -#### name - -###### Required • TypeString - -This is the name of the CSI driver that this object refers to. This MUST be the same name returned by the CSI GetPluginName() call for that driver. -#### node_id - -###### Required • TypeString - -nodeID of the node from the driver point of view. This field enables Kubernetes to communicate with storage systems that do not share the same nomenclature for nodes. For example, Kubernetes may refer to a given node as "node1", but the storage system may refer to the same node as "nodeA". When Kubernetes issues a command to the storage system to attach a volume to a specific node, it can use this field to refer to the node name using the ID that the storage system will understand, e.g. "nodeA" instead of "node1". This field is required. -#### topology_keys - -###### TypeList - -topologyKeys is the list of keys supported by the driver. When a driver is initialized on a cluster, it provides a set of topology keys that it understands (e.g. "company.com/zone", "company.com/region"). When a driver is initialized on a node, it provides the same topology keys along with values. Kubelet will expose these topology keys as labels on its own node object. When Kubernetes does topology aware provisioning, it can use this list to determine which labels it should retrieve from the node object and pass back to the driver. It is possible for different nodes to use different topology keys. This can be empty if driver does not support topology. \ No newline at end of file diff --git a/docs/k8s_config_gatekeeper_sh_v1alpha1_config/README.md b/docs/k8s_config_gatekeeper_sh_v1alpha1_config/README.md deleted file mode 100755 index 122ee90..0000000 --- a/docs/k8s_config_gatekeeper_sh_v1alpha1_config/README.md +++ /dev/null @@ -1,118 +0,0 @@ - -# resource "k8s_config_gatekeeper_sh_v1alpha1_config" - - - - -
-metadata
- - -- [annotations](#annotations) -- [creation_timestamp](#creation_timestamp) -- [deletion_grace_period_seconds](#deletion_grace_period_seconds) -- [deletion_timestamp](#deletion_timestamp) -- [labels](#labels) -- [name](#name) -- [namespace](#namespace) -- [resource_version](#resource_version) -- [self_link](#self_link) -- [uid](#uid) - - -
- - -
-example
- -```hcl -resource "k8s_config_gatekeeper_sh_v1alpha1_config" "this" { - - metadata { - annotations = { "key" = "TypeString" } - labels = { "key" = "TypeString" } - name = "TypeString" - namespace = "TypeString" - } - - spec = "TypeString" -} - - -``` - -
- - -## metadata - -Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - - -#### annotations - -###### TypeMap - -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 -#### creation_timestamp - -###### ReadOnly • TypeString - -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/sig-architecture/api-conventions.md#metadata -#### deletion_grace_period_seconds - -###### ReadOnly • TypeInt - -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. -#### deletion_timestamp - -###### ReadOnly • TypeString - -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/sig-architecture/api-conventions.md#metadata -#### labels - -###### TypeMap - -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 -#### name - -###### TypeString - -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 -#### namespace - -###### TypeString - -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 -#### resource_version - -###### ReadOnly • TypeString - -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/sig-architecture/api-conventions.md#concurrency-control-and-consistency -#### self_link - -###### ReadOnly • TypeString - -SelfLink is a URL representing this object. Populated by the system. Read-only. - -DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release. -#### uid - -###### ReadOnly • TypeString - -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 -#### spec - -###### TypeString - diff --git a/docs/k8s_admissionregistration_k8s_io_v1_mutating_webhook_configuration/README.md b/docs/resources/admissionregistration_k8s_io_v1_mutating_webhook_configuration.md similarity index 100% rename from docs/k8s_admissionregistration_k8s_io_v1_mutating_webhook_configuration/README.md rename to docs/resources/admissionregistration_k8s_io_v1_mutating_webhook_configuration.md diff --git a/docs/k8s_admissionregistration_k8s_io_v1_validating_webhook_configuration/README.md b/docs/resources/admissionregistration_k8s_io_v1_validating_webhook_configuration.md similarity index 100% rename from docs/k8s_admissionregistration_k8s_io_v1_validating_webhook_configuration/README.md rename to docs/resources/admissionregistration_k8s_io_v1_validating_webhook_configuration.md diff --git a/docs/k8s_admissionregistration_k8s_io_v1beta1_mutating_webhook_configuration/README.md b/docs/resources/admissionregistration_k8s_io_v1beta1_mutating_webhook_configuration.md similarity index 100% rename from docs/k8s_admissionregistration_k8s_io_v1beta1_mutating_webhook_configuration/README.md rename to docs/resources/admissionregistration_k8s_io_v1beta1_mutating_webhook_configuration.md diff --git a/docs/k8s_admissionregistration_k8s_io_v1beta1_validating_webhook_configuration/README.md b/docs/resources/admissionregistration_k8s_io_v1beta1_validating_webhook_configuration.md similarity index 100% rename from docs/k8s_admissionregistration_k8s_io_v1beta1_validating_webhook_configuration/README.md rename to docs/resources/admissionregistration_k8s_io_v1beta1_validating_webhook_configuration.md diff --git a/docs/k8s_apiextensions_k8s_io_v1_custom_resource_definition/README.md b/docs/resources/apiextensions_k8s_io_v1_custom_resource_definition.md similarity index 100% rename from docs/k8s_apiextensions_k8s_io_v1_custom_resource_definition/README.md rename to docs/resources/apiextensions_k8s_io_v1_custom_resource_definition.md diff --git a/docs/k8s_apiextensions_k8s_io_v1beta1_custom_resource_definition/README.md b/docs/resources/apiextensions_k8s_io_v1beta1_custom_resource_definition.md similarity index 100% rename from docs/k8s_apiextensions_k8s_io_v1beta1_custom_resource_definition/README.md rename to docs/resources/apiextensions_k8s_io_v1beta1_custom_resource_definition.md diff --git a/docs/k8s_apiregistration_k8s_io_v1_api_service/README.md b/docs/resources/apiregistration_k8s_io_v1_api_service.md similarity index 100% rename from docs/k8s_apiregistration_k8s_io_v1_api_service/README.md rename to docs/resources/apiregistration_k8s_io_v1_api_service.md diff --git a/docs/k8s_apiregistration_k8s_io_v1beta1_api_service/README.md b/docs/resources/apiregistration_k8s_io_v1beta1_api_service.md similarity index 100% rename from docs/k8s_apiregistration_k8s_io_v1beta1_api_service/README.md rename to docs/resources/apiregistration_k8s_io_v1beta1_api_service.md diff --git a/docs/k8s_apps_v1_daemon_set/README.md b/docs/resources/apps_v1_daemon_set.md similarity index 100% rename from docs/k8s_apps_v1_daemon_set/README.md rename to docs/resources/apps_v1_daemon_set.md diff --git a/docs/k8s_apps_v1_deployment/README.md b/docs/resources/apps_v1_deployment.md similarity index 100% rename from docs/k8s_apps_v1_deployment/README.md rename to docs/resources/apps_v1_deployment.md diff --git a/docs/k8s_apps_v1_replica_set/README.md b/docs/resources/apps_v1_replica_set.md similarity index 100% rename from docs/k8s_apps_v1_replica_set/README.md rename to docs/resources/apps_v1_replica_set.md diff --git a/docs/k8s_apps_v1_stateful_set/README.md b/docs/resources/apps_v1_stateful_set.md similarity index 100% rename from docs/k8s_apps_v1_stateful_set/README.md rename to docs/resources/apps_v1_stateful_set.md diff --git a/docs/k8s_auditregistration_k8s_io_v1alpha1_audit_sink/README.md b/docs/resources/auditregistration_k8s_io_v1alpha1_audit_sink.md similarity index 100% rename from docs/k8s_auditregistration_k8s_io_v1alpha1_audit_sink/README.md rename to docs/resources/auditregistration_k8s_io_v1alpha1_audit_sink.md diff --git a/docs/k8s_autoscaling_v1_horizontal_pod_autoscaler/README.md b/docs/resources/autoscaling_v1_horizontal_pod_autoscaler.md similarity index 100% rename from docs/k8s_autoscaling_v1_horizontal_pod_autoscaler/README.md rename to docs/resources/autoscaling_v1_horizontal_pod_autoscaler.md diff --git a/docs/k8s_autoscaling_v2beta1_horizontal_pod_autoscaler/README.md b/docs/resources/autoscaling_v2beta1_horizontal_pod_autoscaler.md similarity index 100% rename from docs/k8s_autoscaling_v2beta1_horizontal_pod_autoscaler/README.md rename to docs/resources/autoscaling_v2beta1_horizontal_pod_autoscaler.md diff --git a/docs/k8s_autoscaling_v2beta2_horizontal_pod_autoscaler/README.md b/docs/resources/autoscaling_v2beta2_horizontal_pod_autoscaler.md similarity index 100% rename from docs/k8s_autoscaling_v2beta2_horizontal_pod_autoscaler/README.md rename to docs/resources/autoscaling_v2beta2_horizontal_pod_autoscaler.md diff --git a/docs/k8s_batch_v1_job/README.md b/docs/resources/batch_v1_job.md similarity index 100% rename from docs/k8s_batch_v1_job/README.md rename to docs/resources/batch_v1_job.md diff --git a/docs/k8s_batch_v1beta1_cron_job/README.md b/docs/resources/batch_v1beta1_cron_job.md similarity index 100% rename from docs/k8s_batch_v1beta1_cron_job/README.md rename to docs/resources/batch_v1beta1_cron_job.md diff --git a/docs/k8s_batch_v2alpha1_cron_job/README.md b/docs/resources/batch_v2alpha1_cron_job.md similarity index 100% rename from docs/k8s_batch_v2alpha1_cron_job/README.md rename to docs/resources/batch_v2alpha1_cron_job.md diff --git a/docs/k8s_core_v1_config_map/README.md b/docs/resources/core_v1_config_map.md similarity index 100% rename from docs/k8s_core_v1_config_map/README.md rename to docs/resources/core_v1_config_map.md diff --git a/docs/k8s_core_v1_endpoints/README.md b/docs/resources/core_v1_endpoints.md similarity index 100% rename from docs/k8s_core_v1_endpoints/README.md rename to docs/resources/core_v1_endpoints.md diff --git a/docs/k8s_core_v1_limit_range/README.md b/docs/resources/core_v1_limit_range.md similarity index 100% rename from docs/k8s_core_v1_limit_range/README.md rename to docs/resources/core_v1_limit_range.md diff --git a/docs/k8s_core_v1_namespace/README.md b/docs/resources/core_v1_namespace.md similarity index 100% rename from docs/k8s_core_v1_namespace/README.md rename to docs/resources/core_v1_namespace.md diff --git a/docs/k8s_core_v1_persistent_volume/README.md b/docs/resources/core_v1_persistent_volume.md similarity index 100% rename from docs/k8s_core_v1_persistent_volume/README.md rename to docs/resources/core_v1_persistent_volume.md diff --git a/docs/k8s_core_v1_persistent_volume_claim/README.md b/docs/resources/core_v1_persistent_volume_claim.md similarity index 100% rename from docs/k8s_core_v1_persistent_volume_claim/README.md rename to docs/resources/core_v1_persistent_volume_claim.md diff --git a/docs/k8s_core_v1_pod/README.md b/docs/resources/core_v1_pod.md similarity index 100% rename from docs/k8s_core_v1_pod/README.md rename to docs/resources/core_v1_pod.md diff --git a/docs/k8s_core_v1_pod_template/README.md b/docs/resources/core_v1_pod_template.md similarity index 100% rename from docs/k8s_core_v1_pod_template/README.md rename to docs/resources/core_v1_pod_template.md diff --git a/docs/k8s_core_v1_replication_controller/README.md b/docs/resources/core_v1_replication_controller.md similarity index 100% rename from docs/k8s_core_v1_replication_controller/README.md rename to docs/resources/core_v1_replication_controller.md diff --git a/docs/k8s_core_v1_resource_quota/README.md b/docs/resources/core_v1_resource_quota.md similarity index 100% rename from docs/k8s_core_v1_resource_quota/README.md rename to docs/resources/core_v1_resource_quota.md diff --git a/docs/k8s_core_v1_secret/README.md b/docs/resources/core_v1_secret.md similarity index 100% rename from docs/k8s_core_v1_secret/README.md rename to docs/resources/core_v1_secret.md diff --git a/docs/k8s_core_v1_service/README.md b/docs/resources/core_v1_service.md similarity index 100% rename from docs/k8s_core_v1_service/README.md rename to docs/resources/core_v1_service.md diff --git a/docs/k8s_core_v1_service_account/README.md b/docs/resources/core_v1_service_account.md similarity index 100% rename from docs/k8s_core_v1_service_account/README.md rename to docs/resources/core_v1_service_account.md diff --git a/docs/k8s_discovery_k8s_io_v1beta1_endpoint_slice/README.md b/docs/resources/discovery_k8s_io_v1beta1_endpoint_slice.md similarity index 100% rename from docs/k8s_discovery_k8s_io_v1beta1_endpoint_slice/README.md rename to docs/resources/discovery_k8s_io_v1beta1_endpoint_slice.md diff --git a/docs/k8s_flowcontrol_apiserver_k8s_io_v1alpha1_flow_schema/README.md b/docs/resources/flowcontrol_apiserver_k8s_io_v1alpha1_flow_schema.md similarity index 100% rename from docs/k8s_flowcontrol_apiserver_k8s_io_v1alpha1_flow_schema/README.md rename to docs/resources/flowcontrol_apiserver_k8s_io_v1alpha1_flow_schema.md diff --git a/docs/k8s_flowcontrol_apiserver_k8s_io_v1alpha1_priority_level_configuration/README.md b/docs/resources/flowcontrol_apiserver_k8s_io_v1alpha1_priority_level_configuration.md similarity index 100% rename from docs/k8s_flowcontrol_apiserver_k8s_io_v1alpha1_priority_level_configuration/README.md rename to docs/resources/flowcontrol_apiserver_k8s_io_v1alpha1_priority_level_configuration.md diff --git a/docs/k8s_networking_k8s_io_v1_network_policy/README.md b/docs/resources/networking_k8s_io_v1_network_policy.md similarity index 100% rename from docs/k8s_networking_k8s_io_v1_network_policy/README.md rename to docs/resources/networking_k8s_io_v1_network_policy.md diff --git a/docs/k8s_networking_k8s_io_v1beta1_ingress/README.md b/docs/resources/networking_k8s_io_v1beta1_ingress.md similarity index 100% rename from docs/k8s_networking_k8s_io_v1beta1_ingress/README.md rename to docs/resources/networking_k8s_io_v1beta1_ingress.md diff --git a/docs/k8s_networking_k8s_io_v1beta1_ingress_class/README.md b/docs/resources/networking_k8s_io_v1beta1_ingress_class.md similarity index 100% rename from docs/k8s_networking_k8s_io_v1beta1_ingress_class/README.md rename to docs/resources/networking_k8s_io_v1beta1_ingress_class.md diff --git a/docs/k8s_node_k8s_io_v1alpha1_runtime_class/README.md b/docs/resources/node_k8s_io_v1alpha1_runtime_class.md similarity index 100% rename from docs/k8s_node_k8s_io_v1alpha1_runtime_class/README.md rename to docs/resources/node_k8s_io_v1alpha1_runtime_class.md diff --git a/docs/k8s_node_k8s_io_v1beta1_runtime_class/README.md b/docs/resources/node_k8s_io_v1beta1_runtime_class.md similarity index 100% rename from docs/k8s_node_k8s_io_v1beta1_runtime_class/README.md rename to docs/resources/node_k8s_io_v1beta1_runtime_class.md diff --git a/docs/k8s_policy_v1beta1_pod_disruption_budget/README.md b/docs/resources/policy_v1beta1_pod_disruption_budget.md similarity index 100% rename from docs/k8s_policy_v1beta1_pod_disruption_budget/README.md rename to docs/resources/policy_v1beta1_pod_disruption_budget.md diff --git a/docs/k8s_policy_v1beta1_pod_security_policy/README.md b/docs/resources/policy_v1beta1_pod_security_policy.md similarity index 100% rename from docs/k8s_policy_v1beta1_pod_security_policy/README.md rename to docs/resources/policy_v1beta1_pod_security_policy.md diff --git a/docs/k8s_rbac_authorization_k8s_io_v1_cluster_role/README.md b/docs/resources/rbac_authorization_k8s_io_v1_cluster_role.md similarity index 100% rename from docs/k8s_rbac_authorization_k8s_io_v1_cluster_role/README.md rename to docs/resources/rbac_authorization_k8s_io_v1_cluster_role.md diff --git a/docs/k8s_rbac_authorization_k8s_io_v1_cluster_role_binding/README.md b/docs/resources/rbac_authorization_k8s_io_v1_cluster_role_binding.md similarity index 100% rename from docs/k8s_rbac_authorization_k8s_io_v1_cluster_role_binding/README.md rename to docs/resources/rbac_authorization_k8s_io_v1_cluster_role_binding.md diff --git a/docs/k8s_rbac_authorization_k8s_io_v1_role/README.md b/docs/resources/rbac_authorization_k8s_io_v1_role.md similarity index 100% rename from docs/k8s_rbac_authorization_k8s_io_v1_role/README.md rename to docs/resources/rbac_authorization_k8s_io_v1_role.md diff --git a/docs/k8s_rbac_authorization_k8s_io_v1_role_binding/README.md b/docs/resources/rbac_authorization_k8s_io_v1_role_binding.md similarity index 100% rename from docs/k8s_rbac_authorization_k8s_io_v1_role_binding/README.md rename to docs/resources/rbac_authorization_k8s_io_v1_role_binding.md diff --git a/docs/k8s_rbac_authorization_k8s_io_v1alpha1_cluster_role/README.md b/docs/resources/rbac_authorization_k8s_io_v1alpha1_cluster_role.md similarity index 100% rename from docs/k8s_rbac_authorization_k8s_io_v1alpha1_cluster_role/README.md rename to docs/resources/rbac_authorization_k8s_io_v1alpha1_cluster_role.md diff --git a/docs/k8s_rbac_authorization_k8s_io_v1alpha1_cluster_role_binding/README.md b/docs/resources/rbac_authorization_k8s_io_v1alpha1_cluster_role_binding.md similarity index 100% rename from docs/k8s_rbac_authorization_k8s_io_v1alpha1_cluster_role_binding/README.md rename to docs/resources/rbac_authorization_k8s_io_v1alpha1_cluster_role_binding.md diff --git a/docs/k8s_rbac_authorization_k8s_io_v1alpha1_role/README.md b/docs/resources/rbac_authorization_k8s_io_v1alpha1_role.md similarity index 100% rename from docs/k8s_rbac_authorization_k8s_io_v1alpha1_role/README.md rename to docs/resources/rbac_authorization_k8s_io_v1alpha1_role.md diff --git a/docs/k8s_rbac_authorization_k8s_io_v1alpha1_role_binding/README.md b/docs/resources/rbac_authorization_k8s_io_v1alpha1_role_binding.md similarity index 100% rename from docs/k8s_rbac_authorization_k8s_io_v1alpha1_role_binding/README.md rename to docs/resources/rbac_authorization_k8s_io_v1alpha1_role_binding.md diff --git a/docs/k8s_rbac_authorization_k8s_io_v1beta1_cluster_role/README.md b/docs/resources/rbac_authorization_k8s_io_v1beta1_cluster_role.md similarity index 100% rename from docs/k8s_rbac_authorization_k8s_io_v1beta1_cluster_role/README.md rename to docs/resources/rbac_authorization_k8s_io_v1beta1_cluster_role.md diff --git a/docs/k8s_rbac_authorization_k8s_io_v1beta1_cluster_role_binding/README.md b/docs/resources/rbac_authorization_k8s_io_v1beta1_cluster_role_binding.md similarity index 100% rename from docs/k8s_rbac_authorization_k8s_io_v1beta1_cluster_role_binding/README.md rename to docs/resources/rbac_authorization_k8s_io_v1beta1_cluster_role_binding.md diff --git a/docs/k8s_rbac_authorization_k8s_io_v1beta1_role/README.md b/docs/resources/rbac_authorization_k8s_io_v1beta1_role.md similarity index 100% rename from docs/k8s_rbac_authorization_k8s_io_v1beta1_role/README.md rename to docs/resources/rbac_authorization_k8s_io_v1beta1_role.md diff --git a/docs/k8s_rbac_authorization_k8s_io_v1beta1_role_binding/README.md b/docs/resources/rbac_authorization_k8s_io_v1beta1_role_binding.md similarity index 100% rename from docs/k8s_rbac_authorization_k8s_io_v1beta1_role_binding/README.md rename to docs/resources/rbac_authorization_k8s_io_v1beta1_role_binding.md diff --git a/docs/k8s_scheduling_k8s_io_v1_priority_class/README.md b/docs/resources/scheduling_k8s_io_v1_priority_class.md similarity index 100% rename from docs/k8s_scheduling_k8s_io_v1_priority_class/README.md rename to docs/resources/scheduling_k8s_io_v1_priority_class.md diff --git a/docs/k8s_settings_k8s_io_v1alpha1_pod_preset/README.md b/docs/resources/settings_k8s_io_v1alpha1_pod_preset.md similarity index 100% rename from docs/k8s_settings_k8s_io_v1alpha1_pod_preset/README.md rename to docs/resources/settings_k8s_io_v1alpha1_pod_preset.md diff --git a/docs/k8s_storage_k8s_io_v1_csi_driver/README.md b/docs/resources/storage_k8s_io_v1_csi_driver.md similarity index 100% rename from docs/k8s_storage_k8s_io_v1_csi_driver/README.md rename to docs/resources/storage_k8s_io_v1_csi_driver.md diff --git a/docs/k8s_storage_k8s_io_v1_csi_node/README.md b/docs/resources/storage_k8s_io_v1_csi_node.md similarity index 100% rename from docs/k8s_storage_k8s_io_v1_csi_node/README.md rename to docs/resources/storage_k8s_io_v1_csi_node.md diff --git a/docs/k8s_storage_k8s_io_v1_storage_class/README.md b/docs/resources/storage_k8s_io_v1_storage_class.md similarity index 100% rename from docs/k8s_storage_k8s_io_v1_storage_class/README.md rename to docs/resources/storage_k8s_io_v1_storage_class.md diff --git a/docs/k8s_storage_k8s_io_v1_volume_attachment/README.md b/docs/resources/storage_k8s_io_v1_volume_attachment.md similarity index 100% rename from docs/k8s_storage_k8s_io_v1_volume_attachment/README.md rename to docs/resources/storage_k8s_io_v1_volume_attachment.md diff --git a/docs/k8s_storage_k8s_io_v1alpha1_volume_attachment/README.md b/docs/resources/storage_k8s_io_v1alpha1_volume_attachment.md similarity index 100% rename from docs/k8s_storage_k8s_io_v1alpha1_volume_attachment/README.md rename to docs/resources/storage_k8s_io_v1alpha1_volume_attachment.md diff --git a/docs/k8s_storage_k8s_io_v1beta1_csi_driver/README.md b/docs/resources/storage_k8s_io_v1beta1_csi_driver.md similarity index 100% rename from docs/k8s_storage_k8s_io_v1beta1_csi_driver/README.md rename to docs/resources/storage_k8s_io_v1beta1_csi_driver.md diff --git a/docs/k8s_storage_k8s_io_v1beta1_storage_class/README.md b/docs/resources/storage_k8s_io_v1beta1_storage_class.md similarity index 100% rename from docs/k8s_storage_k8s_io_v1beta1_storage_class/README.md rename to docs/resources/storage_k8s_io_v1beta1_storage_class.md diff --git a/docs/k8s_storage_k8s_io_v1beta1_volume_attachment/README.md b/docs/resources/storage_k8s_io_v1beta1_volume_attachment.md similarity index 100% rename from docs/k8s_storage_k8s_io_v1beta1_volume_attachment/README.md rename to docs/resources/storage_k8s_io_v1beta1_volume_attachment.md