Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: New Documents for helm-installer Plugin #1214

Merged
merged 2 commits into from
Nov 1, 2022
Merged

Docs: New Documents for helm-installer Plugin #1214

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4b8ad85
docs: new documents for helm-installer plugin
daniel-hutao Oct 28, 2022
8e1b58f
fix: links error in documents
daniel-hutao Nov 1, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions docs/best-practices/air-gapped-deployment.zh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# 离线部署

// TODO(daniel-hutao): to update according helm-installer plugin added.

本文将和你介绍如何在离线环境中使用 DevStream。

!!! info "提醒"
Expand Down Expand Up @@ -51,8 +53,8 @@ harbor-linux-amd64_0.9.1.md5 harbor-linux-amd64_0.9.1.so jenkins-linux-amd64_0

如果 DevStream 的某个插件是使用容器化方式部署一个应用，那么其在支持离线部署的时候，就一定会提供镜像列表。比如 Jenkins 和 Harbor 的镜像列表分别如下：

1. [Jenkins images](../plugins/jenkins/jenkins-images.txt)
2. [Harbor images](../plugins/harbor/harbor-images.txt)
1. [Jenkins images](../plugins/helm-installer/jenkins/jenkins-images.txt)
2. [Harbor images](../plugins/helm-installer/harbor/harbor-images.txt)

你可以通过如下命令将镜像列表下载到本地：

Expand Down Expand Up @@ -171,7 +173,7 @@ harbor-1.10.0.tgz jenkins-4.2.5.tgz
tag: 0.2.0
```

关于 jenkins 插件的详细文档可以看[ jenkins 插件文档](../plugins/jenkins.zh.md)。
关于 jenkins 插件的详细文档可以看[ jenkins 插件文档](../plugins/helm-installer/helm-installer.zh.md)。

=== "harbor 插件"

Expand Down Expand Up @@ -274,7 +276,7 @@ harbor-1.10.0.tgz jenkins-4.2.5.tgz
accessMode: ReadWriteOnce
size: 1Gi
```
关于 harbor 插件的详细文档可以看[ harbor 插件文档](../plugins/harbor.zh.md)。
关于 harbor 插件的详细文档可以看[ harbor 插件文档](../plugins/helm-installer/helm-installer.zh.md)。

### 4.2、编写主配置和变量配置

Expand Down
10 changes: 6 additions & 4 deletions docs/best-practices/gitlab-jenkins-harbor.zh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# 本地部署 GitLab + Jenkins + Harbor 工具链

// TODO(daniel-hutao): to update according helm-installer plugin added.

!!! abstract "概述"

本文将介绍如何通过 DevStream 在本地部署 `GitLab + Jenkins + Harbor` 工具链，并且以 Java Spring Boot 项目为例，
Expand All @@ -22,8 +24,8 @@

- **工具链搭建**
- [`gitlab-ce-docker`](../plugins/gitlab-ce-docker.zh.md)：本地部署 GitLab 环境；
- [`jenkins`](../plugins/jenkins.zh.md)：本地部署 Jenkins 环境；
- [`harbor`](../plugins/harbor.zh.md)：本地部署 Harbor 环境。
- [`jenkins`](../plugins/helm-installer/helm-installer.zh.md)：本地部署 Jenkins 环境；
- [`harbor`](../plugins/helm-installer/helm-installer.zh.md)：本地部署 Harbor 环境。
- **工具链使用**
- [`repo-scaffolding`](../plugins/repo-scaffolding.zh.md)：创建 Java Spring Boot 项目脚手架；
- [`jenkins-pipeline`](../plugins/jenkins-pipeline.zh.md)：在 Jenkins 上创建 Pipeline，并打通 GitLab 与 Jenkins，实现 GitLab 上发生 Push/Merge 等事件时触发 Jenkins Pipeline 运行，并且让 Pipeline 状态能够回写到 GitLab。
Expand Down Expand Up @@ -114,7 +116,7 @@

=== "jenkins 插件"

jenkins 插件的配置如下（该插件的详细文档参见[ jenkins 插件文档](../plugins/jenkins.zh.md)）：
jenkins 插件的配置如下（该插件的详细文档参见[ jenkins 插件文档](../plugins/helm-installer/helm-installer.zh.md)）：

```yaml title="Plugin Config with jenkins"
- name: jenkins
Expand Down Expand Up @@ -161,7 +163,7 @@

=== "harbor 插件"

harbor 插件的配置如下（该插件的详细文档参见[ harbor 插件文档](../plugins/harbor.zh.md)）：
harbor 插件的配置如下（该插件的详细文档参见[ harbor 插件文档](../plugins/helm-installer/helm-installer.zh.md)）：

```yaml title="Plugin Config with harbor"
- name: harbor
Expand Down
4 changes: 3 additions & 1 deletion docs/best-practices/gitops.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# GitOps Toolchain

// TODO(daniel-hutao): to update according helm-installer plugin added.

If you are interested in watching a video demo, see the youtube video below:

<iframe width="100%" height="500" src="https://www.youtube.com/embed/q7TK3vFr1kg" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
Expand All @@ -19,7 +21,7 @@ For Chinese readers, watch this one instead:
1. [repo-scaffolding](../plugins/repo-scaffolding.md)
2. [jira-github](../plugins/jira-github-integ.md)
3. [githubactions-golang](../plugins/githubactions-golang.md)
4. [argocd](../plugins/argocd.md)
4. [argocd](../plugins/helm-installer/helm-installer.md)
5. [argocdapp](../plugins/argocdapp.md)

The dependencies of these plugins are(`a -> b` means for `a depends on b`):
Expand Down
4 changes: 3 additions & 1 deletion docs/best-practices/gitops.zh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# GitOps 工具链

// TODO(daniel-hutao): to update according helm-installer plugin added.

请参考视频demo来快速熟悉用DevStream来实施GitOps工具链的部署和整合：
- YouTube
<iframe width="100%" height="500" src="https://www.youtube.com/embed/q7TK3vFr1kg" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
Expand All @@ -11,7 +13,7 @@
1. [repo-scaffolding](../plugins/repo-scaffolding.zh.md)
2. [jira-github](../plugins/jira-github-integ.zh.md)
3. [githubactions-golang](../plugins/githubactions-golang.zh.md)
4. [argocd](../plugins/argocd.zh.md)
4. [argocd](../plugins/helm-installer/helm-installer.zh.md)
5. [argocdapp](../plugins/argocdapp.zh.md)

这些插件的依赖关系如下（`a -> b`意味着`a依赖b`）：
Expand Down
2 changes: 1 addition & 1 deletion docs/plugins/argocdapp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This plugin creates an [ArgoCD Application](https://argo-cd.readthedocs.io/en/st
**Notes:**

- ArgoCD itself must have been already installed before the usage of this plugin.
To install ArgoCD, use the [argocd plugin](./argocd.md).
To install ArgoCD, use the [helm-installer plugin](./helm-installer/argocd.md).
Or you can use both plugins(argocd+argocdapp) at the same time.
See [GitOps Toolchain](../best-practices/gitops.md) for more info.
- Currently, only the Helm chart is supported when creating the ArgoCD application.
Expand Down
15 changes: 14 additions & 1 deletion docs/plugins/helm-installer/argocd.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,16 @@
# Install Argo CD with DevStream

//TODO(daniel-hutao): to be updated
## Default Configs

| key | default value | description |
| ---------------- | ------------------------------------ | ------------------------------------------------ |
| chart.chartPath | "" | local chart path |
| chart.chartName | argo/argo-cd | chart name |
| chart.version | "" | chart version |
| chart.timeout | 10m | this config will wait 10 minutes to deploy Argo CD |
| chart.upgradeCRDs | true | default update CRD config |
| chart.releaseName | argocd | helm release name |
| chart.namespace | argocd | namespace where helm to deploy |
| chart.wait | true | whether to wait until installation is complete |
| repo.url | https://argoproj.github.io/argo-helm | helm official repo address |
| repo.name | argo | helm repo name |
15 changes: 14 additions & 1 deletion docs/plugins/helm-installer/argocd.zh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,16 @@
# 使用 DevStream 部署 Argo CD

//TODO(daniel-hutao): to be updated
## 默认配置

| 配置项 | 默认值 | 描述 |
| ---- | ---- | ---- |
| chart.chartPath | "" | 本地 chart 包路径 |
| chart.chartName | argo/argo-cd | chart 包名称 |
| chart.version | "" | chart 包版本 |
| chart.timeout | 10m | helm install 的超时时间 |
| chart.upgradeCRDs | true | 是否更新 CRDs（如果有） |
| chart.releaseName | argocd | helm 发布名称 |
| chart.namespace | argocd | 部署的命名空间 |
| chart.wait | true | 是否等待部署完成 |
| repo.url | https://argoproj.github.io/argo-helm | helm 仓库地址 |
| repo.name | argo | helm 仓库名 |
53 changes: 18 additions & 35 deletions docs/plugins/helm-installer/artifactory.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,20 @@
# Install Artifactory with DevStream

//TODO(daniel-hutao): to be updated
## Default Configs

This plugin installs [artifactory](https://jfrog.com/artifactory/) in an existing Kubernetes cluster using the Helm chart.

## Usage
| key | default value | description |
| ---- | ---- | ---- |
| chart.chartPath | "" | local chart path |
| chart.chartName | jfrog/artifactory | chart name |
| chart.timeout | 10m | this config will wait 10 minutes to deploy |
| chart.releaseName | artifactory | helm release name |
| chart.upgradeCRDs | true | default update CRD config |
| chart.wait | true | whether to wait until installation is complete |
| chart.namespace | artifactory | namespace where helm to deploy |
| repo.url | https://charts.jfrog.io | offical helm repo address |
| repo.name | jfrog | helm repo name |

### Test/Local Dev Environment
## Test/Local Dev Environment

If you want to **test the plugin locally**， The following `valuesYaml` configuration can be used

Expand All @@ -26,41 +34,16 @@ In this configuration
- local disks on machines in the cluster are defaulted used for data mounting.
- Using `nodePort` to expose service, You can access `artifactory` by domain `http://{{k8s node IP}}:30002`. The default account name and password are admin/password (please replace the default account password in the production environment).

### Production Environment
## Production Environment

#### External Storage
### External Storage

- PostgreSQL: Set the `database.url` to Postgresql's address. More info can be found in [Config](https://www.jfrog.com/confluence/display/JFROG/Configuring+the+Database).

#### Disk Storage
### Disk Storage

You can set `customVolumes` and `customVolumeMounts` for this service. More info can be found in [Config](https://www.jfrog.com/confluence/display/JFROG/Configuring+the+Filestore).

#### Network Config

This plugin support`Ingress`, `ClusterIP`, `NodePort` and `LoadBalancer` , You can give choice to your needs.

### Config

The following content is an example of the "tool file".

For more information on the main config, the tool file and the var file of DevStream, see [Core Concepts Overview](../core-concepts/core-concepts.md#1-config) and [DevStream Configuration](../core-concepts/config.md).
### Network Config

```yaml
--8<-- "artifactory.yaml"
```

#### Default Configs

| key | default value | description |
| ---- | ---- | ---- |
| chart.chartPath | "" | local chart path |
| chart.chartName | jfrog/artifactory | chart name |
| chart.timeout | 10m | this config will wait 10 minutes to deploy |
| chart.releaseName | artifactory | helm release name |
| chart.upgradeCRDs | true | default update CRD config |
| chart.wait | true | whether to wait until installation is complete |
| chart.namespace | artifactory | namespace where helm to deploy |
| repo.url | https://charts.jfrog.io | offical helm repo address |
| repo.name | jfrog | helm repo name |
Currently, except for `valuesYaml` and default configs, all the parameters in the example above are mandatory.
This plugin support `Ingress`, `ClusterIP`, `NodePort` and `LoadBalancer` , You can give choice to your needs.
53 changes: 18 additions & 35 deletions docs/plugins/helm-installer/artifactory.zh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,21 @@
# 使用 DevStream 部署 Artifactory

//TODO(daniel-hutao): to be updated
## 默认配置

这个插件使用 helm 在已有的 k8s 集群上安装 [artifactory](https://jfrog.com/artifactory/)。

## 使用方法
| key | default value | description |
| ---- | ---- | ---- |
| chart.chartPath | "" | 本地 chart 包路径 |
| chart.chartName | jfrog/artifactory | chart 名称 |
| chart.version | "" | chart 版本 |
| chart.timeout | 10m | 等待部署成功的时间 |
| chart.upgradeCRDs | true | 默认更新 CRD 配置（如果存在的话） |
| chart.releaseName | artifactory | helm 发布名称 |
| chart.namespace | artifactory | helm 部署的命名空间名称 |
| chart.wait | true | 是否等待部署完成 |
| repo.url | https://charts.jfrog.io | helm 官方仓库地址 |
| repo.name | jfrog | helm 仓库名 |

### 测试环境
## 测试环境

如果你想在**本地测试插件**， 可以使用如下 `valuesYaml` 配置。

Expand All @@ -26,42 +35,16 @@ valuesYaml: |
- 数据挂载的磁盘默认会使用集群上机器的本地磁盘；
- 通过 `NodePort` 对外暴露服务，可使用 `http://{{k8s 节点ip}}:30002` 域名来访问，默认账号名密码为 admin/password (生产环境请替换默认账号密码)。

### 生产环境
## 生产环境

#### 外部存储
### 外部存储

- PostgreSQL：设置 `database.url` 来设置数据库地址，具体配置可参考 [Config](https://www.jfrog.com/confluence/display/JFROG/Configuring+the+Database) 中的选项。

#### 磁盘存储
### 磁盘存储

可以设置 `customVolumes` 和 `customVolumeMounts` 来配置挂载磁盘，具体配置可参考 [Config](https://www.jfrog.com/confluence/display/JFROG/Configuring+the+Filestore)。

#### 网络层配置
### 网络层配置

该插件支持 `Ingress`, `ClusterIP`, `NodePort`, `LoadBalancer` 对外暴露的模式，可以基于需求进行选择。

### 配置

下面的配置文件展示的是"tool file"的内容。

关于更多关于DevStream的主配置、tool file、var file的信息，请阅读[核心概念概览](../core-concepts/core-concepts.zh.md)和[DevStream配置](../core-concepts/config.zh.md).

```yaml
--8<-- "artifactory.yaml"
```

#### 默认配置

| key | default value | description |
| ---- | ---- | ---- |
| chart.chartPath | "" | 本地 chart 包路径 |
| chart.chartName | jfrog/artifactory | helm 包名称 |
| chart.timeout | 10m | 等待部署成功的时间 |
| chart.upgradeCRDs | true | 默认更新 CRD 配置（如果存在的话） |
| chart.releaseName | artifactory | helm 发布名称 |
| chart.wait | true | 是否等待部署完成 |
| chart.namespace | artifactory | helm 部署的命名空间名称 |
| repo.url | https://charts.jfrog.io | helm 官方仓库地址 |
| repo.name | jfrog | helm 仓库名 |

目前除了 `valuesYaml` 字段和默认配置，其它所有示例参数均为必填项。
23 changes: 13 additions & 10 deletions docs/plugins/helm-installer/devlake.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@
# Install DevLake with DevStream

//TODO(daniel-hutao): to be updated
## Default Configs

## Usage

The following content is an example of the "tool file".

For more information on the main config, the tool file and the var file of DevStream, see [Core Concepts Overview](../core-concepts/core-concepts.md#1-config) and [DevStream Configuration](../core-concepts/config.md).

``` yaml
--8<-- "devlake.yaml"
```
| key | default value | description |
| ---------------- | ------------------------------------ | ------------------------------------------------ |
| chart.chartPath | "" | local chart path |
| chart.chartName | "devlake/devlake | chart name |
| chart.version | "" | chart version |
| chart.timeout | 10m | this config will wait 10 minutes to deploy DevLake |
| chart.upgradeCRDs | true | default update CRD config |
| chart.releaseName | devlake | helm release name |
| chart.namespace | devlake | namespace where helm to deploy |
| chart.wait | true | whether to wait until installation is complete |
| repo.url | https://merico-dev.github.io/devlake-helm-chart | helm official repo address |
| repo.name | devlake | helm repo name |
Loading