Helm docs 生成 README.md

最新推荐文章于 2023-07-11 21:12:08 发布
最新推荐文章于 2023-07-11 21:12:08 发布
阅读量283 收藏
点赞数
分类专栏： 跟mark学helm 文章标签： kubernetes
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_25221835/article/details/120250022
版权

一个好的应用必定有一套好的文档，文档的质量往往和代码的质量成正比。而 Helm Chart 中的 README.md 文件就承担了文档的作用。

chart的自述文件README文件应该使用Markdown格式(README.md)，一般应包含：

  • chart提供的应用或服务的描述
  • 运行chart的先决条件或要求
  • values.yaml的可选项和默认值的描述
  • 与chart的安装或配置相关的其他任何信息

README.md 文件会包含hub和用户接口显示的chart的详细信息。

Helm-docs

helm-docs 可以根据 charts 内容自动生成 markdown 文件。该文件会包含有关 charts 的元数据，以及 value.yaml 中的参数，同时还可以引用子模板（默认为 README.md.gotmpl），进一步定制生成的内容。

安装

helm-docs 使用 golang 开发，支持多平台：

wget https://github.com/norwoodj/helm-docs/releases/download/v1.5.0/helm-docs_1.5.0_Linux_x86_64.tar.gz

tar zxvf helm-docs_1.5.0_Linux_x86_64.tar.gz

mv helm-docs /usr/local/bin/helm-docs

了解本专栏 订阅专栏 解锁全文 超级会员免费看
一彡十
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
订阅专栏
helm-docs:自动生成舵图的降价文档的工具
05-13
舵文档 helm-docs工具会自动将helm图表中的文档生成为markdown文件。 生成的文件包含有关其各自图表的元数据和一个表格，其中包含图表的每个值，其默认值以及从注释中解析出来的可选描述。 降价生成完全由驱动。 该工具从图表中解析元数据，并生成可在模板文件中引用的多个子模板（默认情况下为README.md.gotmpl ）。 如果未提供模板文件，则该工具具有默认的内部模板，该模板将生成合理格式的自述文件。 该工具最有用的方面是从注释自动检测字段描述： config : databasesToCreate : # -- default database for storage of database metadata - postgres # -- database for the [hashbash](https://github.com/no
Helm~docs
Qbit编程学习笔记
05-06 150
Welcome Welcome to the Helm documentation. Helm is the package manager for Kubernetes, and you can read detailed background information in the CNCF Helm Project Journey report. 欢迎 欢迎阅读Helm文档。Helm是一个Kubernetes的包管理器，你可以在CNCF Helm Project Journey report得到它更详尽
goreadme：从Go doc生成自述文件。 现在可用于Github动作！
02-01
goreadme 软件包goreadme从go doc生成自述文件markdown文件。 该软件包可用作命令行工具和Github操作，如下所述： Github动作 可以配置Github操作以在每次需要时自动更新README文件。 下面有一个示例，每次将新更改推送到master分支时，都会触发该操作，生成新的README文件，如果有更改，则将其提交并推送到master分支。 在影响README内容的请求请求中，如果给出了github-token ，则该操作将在请求请求中添加注释，并带有将对README文件进行的更改。 要将其与Github操作一起使用，请将以下内容添加到.github/workflows/goreadme.yml 。 有关所有可用的输入选项，请参见 。 on: push: branches: [ master ] pull_request : branches: [ master ] jobs : goreadme: runs - on : ubuntu - latest steps:
Helm 常用命令小记
海鸥
12-20 5201
官网：https://helm.sh/zh/docs/helm/ Helm helm #查看helm基本操作命令 helm version #查看helm的版本 helm env #查看环境变量 helm create chartName #创建chart目录（含基本配置文件和目录） helm package chartDir #将chart目录打包 helm template chartName #渲染template目录下的模板文件（即将这些模...
Helm简介,安装与使用
热门推荐
weiguang1017的专栏
09-20 4万+
Helm简介：       Helm把Kubernetes资源(比如deployments、services或 ingress等) 打包到一个chart中，而chart被保存到chart仓库。通过chart仓库可用来存储和分享chart。Helm使发布可配置，支持发布应用配置的版本管理，简化了Kubernetes部署应用的版本控制、打包、发布、删除、更新等操作。 安装 i.Helm
helm部署gitlab.md
最新发布
09-15
使用helm chart 将gitlab部署到k8s集群之上
helm-v2.16.10-linux-amd64.tar.gz
08-26
就这资源竟然还有人要币才能下载，真的是想钱想疯了吧，互联网本就应该开放包容，被这群人搞得乌烟瘴气，我说了，免费下载；别改我下载积分了。。。。
helm-v2.16.6-linux-amd64.tar.gz
04-28
helm2.16.6版本，解压后 mv linux-amd64/helm /usr/local/bin/ ，并增加权限 chmod +x /usr/local/bin/helm
helm-3.5.3.tar.gz
03-18
helm-3.5.3.tar.gz
helm-v2.16.9-linux-amd64.tar.gz
07-01
helm-v2.16.9-linux-amd64.tar.gz git上下载很慢，所以自己下载好后，上传了一个
clerical:从jsdoc样式的文档块自动生成README.md文件
05-22
Clerical.js 从jsdoc样式的文档块自动生成README.md文件。 import Clerical from "clerical" ; const clerical = new Clerical ; clerical . saySomething ( ) ; // will output "Something" 质量和兼容性 每个构建和发行版都会在以下平台上自动进行测试： 如果上面未列出您的平台，则可以通过将以下命令复制并粘贴到终端中来测试本地环境的兼容性： npm install clerical cd node_modules/clerical gulp test-local 安装 将以下命令复制并粘贴到终端中以安装Clerical： npm install clerical --save 导入/要求 // ES6 import clerical f
Go-Rebecca是一个Go开发的readme内容生成器
08-14
Rebecca是一个Go开发的readme内容生成器
从Readmemd文件创建美观简单的HTML页面
08-11
从Readme.md文件创建美观简单的HTML页面
Helm3安装和使用
YIYIYI
07-11 1862
Helm3安装和使用
Word doc/docx 格式文件转换为 MarkDown
异想之旅的博客
09-20 7634
异想之旅：本人博客完全手敲，绝对非搬运，全网不可能有重复；本人无团队，仅为技术爱好者进行分享，所有内容不牵扯广告。本人所有文章发布平台为CSDN和博客园，后期可能会有个人博客，除此之外全部是盗文！ （闲聊，忙人跳过） 今天忽然想要把自己的 资源分享文章 从腾讯文档转移到自己的服务器上，搭建一个公共md文档展示服务器。于是开始百度如何转换 docx 为 md 文件。 在此过程中也可谓是一波三折，有很多教程很详细但实在太麻烦，有一些过期了，还有一些是外网……（此处提醒一下，在线的那些效果都不理想） 最终在知乎
win10 编写脚本，添加右键菜单，简化创建README.md文件
全属性程序员
10-10 2316
win10 新建.md文件比较麻烦，每次右键-新建 *.txt,之后重命名后缀为md,步骤比较多。 而我经常需要新建 *.md文件，作为一个程序员，应该把简单重复的事情交给程序去搞定， 今天就写个简单脚本，解放自己双手。 两种解决方案：都很方便 一、增加鼠标右键菜单，点击后生成README.md。 二、在cmd指令框，输入指令，生成README.md。
tree 命令
weixin_30917213的博客
07-13 595
LMXMN117:Mac Driver will.wei$ tree -N >/tmp/savs.txt (1)tree -a 显示所有文件和目录 (2)tree -d 显示目录名称而非内容 (3)tree -f 在每个文件或目录之前，显示完整的相对路径名称 ...
doc 转 md
Quan的博客
04-23 2963
有一个网站不错,在线转的, 它会把图片转成 base64编码，最好还是将图片保存一下，使用链接的方式，不然md文档太大。 https://word-to-markdown.herokuapp.com/ 使用 unoconv 和 pandoc (抄的，未验证) # 安装工具 yum install -y unoconv pandoc # 将 word 文件转换 html unoconv -...
GitHub上README写法暨GFM语法解读
weixin_30730053的博客
04-15 2591
转载请保留原作者guodongxiaren的原文地址。 自从开始玩GitHub以来，就越来越感觉它有爱。最近对它的README.md文件颇为感兴趣。便写下这贴，帮助更多的还不会编写README文件的同学们。 README文件后缀名为md。md是markdown的缩写，markdown是一种编辑博客的语言。用惯了可视化的博客编辑器（比如CSDN博客，囧），这种编程式的博客编辑方案着实...
打开 Helm 仓库的 index.yaml 文件
07-15
要打开 Helm 仓库的 `index.yaml` 文件，您可以使用文本编辑器或命令行工具执行以下步骤： 1. 打开终端或命令提示符。 2. 切换到包含 Helm 仓库的目录。例如，如果您的仓库位于 `/path/to/repo`，则执行以下命令： ``` cd /path/to/repo ``` 3. 使用您喜欢的文本编辑器（如 `vi`、`nano` 或 `notepad`）打开 `index.yaml` 文件。例如，使用 `vi` 打开： ``` vi index.yaml ``` 或使用默认关联的文本编辑器打开： ``` notepad index.yaml ``` 4. 文件将在编辑器中打开，您可以查看和编辑其中的内容。 5. 在完成对文件的更改后，保存并关闭编辑器。 请注意，这里假设您已经具有适当的权限来访问和修改该文件。确保您以管理员身份运行命令或具有适当的文件权限。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

一彡十

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值