cloudstate icon indicating copy to clipboard operation
cloudstate copied to clipboard

Missing documentation for cloudstate.io resources (kubectl explain)

Open michaelpnash opened this issue 4 years ago • 0 comments

As of 2020-05-23, cloudstate.io resources are:

$ kubectl api-resources --api-group=cloudstate.io NAME SHORTNAMES APIGROUP NAMESPACED KIND routes cloudstate.io true Route statefulservices cloudstate.io true StatefulService statefulstores cloudstate.io true StatefulStore Using kubectl explain resource_name to get a quick description and fields of a resource. But the documentation is empty. Here is an example on statefulservices

$ kubectl explain statefulservices KIND: StatefulService VERSION: cloudstate.io/v1alpha1

DESCRIPTION: Expected outcome: should have similar documentation as resources of other api-groups. Here is an example on the resource type deployments

$ kubectl explain deployments KIND: Deployment VERSION: extensions/v1beta1

DESCRIPTION: DEPRECATED - This group version of Deployment is deprecated by apps/v1beta2/Deployment. See the release notes for more information. Deployment enables declarative updates for Pods and ReplicaSets.

FIELDS: apiVersion 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

kind 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

metadata <Object> Standard object metadata.

spec <Object> Specification of the desired behavior of the Deployment.

status <Object> Most recently observed status of the Deployment.

(copied into this repo on behalf of @tringuyen-yw )

michaelpnash avatar May 27 '20 13:05 michaelpnash