使用Jupyter Notebook创建给最牛的Ansible模块开发者的教育文档
我为了开发Ansible模块的教育文档而苦恼,但是我想如果使用Jupyter notebook和Jupyter Ansible Kernel就可以在Jupyter中运行并获得一个(在我看来)最棒的环境。所以我试着去做,成功了,现在我写下来。
目的是什么?
创建一个能够向 Ansible 模块开发者介绍 module_utils 中方法的说明文档,并提供方法的使用示例和实现方法。
2. 课本形象
以下是一篇关于Ansible的module_utils中的VMware find_obj方法的文档。
正如谚语所说,“百闻不如一见”,以下是一个示意视频。

如果上面的图像无法显示,请点击下面的图片(链接)。

这是我试着创建的Jupyter笔记本文件。
请将以下内容以中文本地化,只需要一个选项:
https://github.com/sky-joker/ore-ore-ansible/blob/master/doc/ansible/module_utils/vmware/find_obj.ipynb
请将此链接转为中文本地化:https://github.com/sky-joker/ore-ore-ansible/blob/master/doc/ansible/module_utils/vmware/find_obj.ipynb
3. 解释
請在文檔中描述並提供 find_obj 函數的參數和返回值的概念圖。接下來,創建一個用於驗證 find_obj 函數操作的 Python 腳本並運行。一旦確定了 find_obj 函數的操作步驟,就可以創建一個使用 find_obj 函數的 Ansible 模塊示例文件。這個文件包含了源代碼,可以清楚地了解如何編寫代碼。完成了 Ansible 模塊的創建後,將其修改為可在 Ansible Kernel 中運行。在將 Ansible 模塊部署到環境之前,請根據環境進行 Ansible 相關配置,然後運行該模塊以驗證其操作。
4. 用手碰触并移动
使用静态文档(如Word或Wiki)很难想象,但通过使用Jupyter可以实际操作和学习 🙂
通过Jupyter,可以嵌入视频文件,也可以使用Git进行管理,这样就可以拓宽梦想的空间 🙂
5. 参考 -> 参照
我已经整理了将Jupyter Ansible Kernel导入venv环境的方法,请参阅下方。
因为在venv环境中安装Ansible Jupyter Kernel时遇到了问题,因此将其作为备忘录记下来。