ansible.kubernetes-modules
已废弃
这些模块已经被废弃,取而代之的是在 Ansible 2.5 中新增的 k8s_raw 和 openshift_raw 模块。
ansible-kubernetes-modules
提供对 K8s 模块最新版本的访问。
在剧本中包含此角色,任何其他剧本、角色和包含的内容都可以访问这些模块。
模块位于 library 文件夹。每个模块都有完整的参数和返回数据结构的文档。不过,并不是所有模块都有示例,只有那些创建了 测试数据 的模块才会有示例。
如果您发现某个特定模块的问题或有建议,请在 OpenShift Rest Client 仓库 提交问题。
为了方便起见,k8s_common.py
和 openshift_common.py
模块包含在 module_utils 下。这些模块目前不是官方 Ansible 版本的一部分,但它是 Ansible 的一部分,并且位于 devel
分支中。与此同时,如果您碰到错误或想要做更改,请在 Ansible 仓库 提交问题并提交拉取请求。
要求
- Ansible
- 在执行模块的主机上安装 OpenShift Rest Client。
安装和使用
使用 Galaxy 客户端安装角色:
$ ansible-galaxy install ansible.kubernetes-modules
安装后,将其添加到剧本中:
---
- hosts: localhost
remote_user: root
roles:
- role: ansible.kubernetes-modules
install_python_requirements: no
- role: hello-world
由于引用了此角色,hello-world
角色可以使用 K8s 模块部署应用程序。要查看实际角色的内容,请查看 tests/roles 文件夹。
与 API 认证
这些模块直接与 Kubernetes 或 OpenShift API 交互。并不需要安装 kubectl
或 oc
CLI 工具。
模块参数
OpenShift 休息客户端需要一个 Kubernetes 配置文件。使用以下选项来控制它查找文件的位置,以及用于与 API 进行身份验证的上下文:
kubeconfig
配置文件的默认路径为
~/.kube/config
。用来传递备用文件路径。
context
用于身份验证的配置上下文名称。如果未指定,则使用当前的活动上下文。
使用以下参数覆盖配置文件中的设置:
host
提供 API 服务器的 URL。
ssl_ca_cert
证书颁发机构证书文件的路径。
cert_file
服务器证书文件的路径。
key_file
私钥文件的路径。
api_key
API 令牌。
verify_ssl
设置为 true 或 false。如果为 false,将不强制验证 SSL。
环境变量
与其将身份验证设置作为参数传递给各个模块,不如通过环境变量传递信息。环境变量的名称为 K8S_AUTH_ 后面跟上大写的变量名。例如,key_file 将变为 K8S_AUTH_KEY_FILE。
角色变量
install_python_requirements
如果您希望安装 OpenShift Rest Client,则设置为 true。默认值为 false。将通过
pip
安装。
virtualenv
提供在安装
pip
软件包时要使用的虚拟环境名称。
许可证
Apache V2