我正在尝试将Google Cloud设置为我的默认云工具。到目前为止,一切正常,并遵循了文档说明。 为了能够使用kubernetes环境自动化某些事情(例如,创建部署-服务-入口-...),我正在研究YAML清单。
现在的问题是:我找到了有关如何创建例如基于YAML清单的部署,但我找不到清单的描述/文档(即,哪些属性可用,它们具有什么目的)。
有人知道在哪里找到这些东西吗?
答案 0 :(得分:1)
我找到了有关如何创建例如基于Yaml清单的部署,但是我找不到清单的描述/文档(即,哪些属性可用,它们具有什么目的)。
Kubernetes API规范应该是您检查的第一位(link)。该页面具有指向k8s API的常规页面以及您在YAML清单中表达的每种API列表的向外链接。如在k8s发行版中所定义的,每种API版本都有此文档的一个版本。 (对于v1.11,当前文档为here。)
为清楚起见,您使用的组件Google Kubernetes Engine是容器编排平台Kubernetes(通常缩写为k8s)的托管实例。 k8s规范是由独立于Google的k8s项目维护者定义和维护的(尽管认识到k8s在Google基础架构中的重要性,尽管有很多Google员工为该项目做出了贡献!)。
k8s团队为API实体发布了一个自动生成的文档网站,您可以在上面发布的链接中找到该网站。尽管值得注意的是,尽管API规范是很好的参考手册,但是该项目在文档方面做得很好。如果您希望获得更多的概念上的理解,建议与other k8s documentation一起阅读。
答案 1 :(得分:1)
您可以直接从kubectl
工具获得清单选项的简要说明:
$ kubectl explain --help
列出受支持资源的字段
此命令描述与每个受支持的API关联的字段 资源。通过简单的JSONPath标识符来标识字段:
<type>.<fieldName>[.<fieldName>]
添加
--recursive
标志以一次显示所有字段 没有描述。有关每个字段的信息可从中检索 OpenAPI格式的服务器。使用“
kubectl api-resources
”获得受支持的完整列表 资源。示例:
获取资源及其字段的文档
kubectl explain pods
获取资源特定字段的文档
kubectl explain pods.spec.containers
选项:
--api-version='': Get different explanations for particular API version --recursive=false: Print the fields of fields (Currently only 1 level deep)
用法:kubectl解释资源[选项]
使用“
kubectl options
”获得全局命令行选项的列表 (适用于所有命令)。
以下是pods.spec.containers.image
解释的示例输出:
$ kubectl explain pods.spec.containers.image
KIND: Pod
VERSION: v1
FIELD: image <string>
DESCRIPTION:
Docker image name. More info:
https://kubernetes.io/docs/concepts/containers/images This field is
optional to allow higher level config management to default or override
container images in workload controllers like Deployments and StatefulSets.