Apache DevLake Helm Chart 使用教程

Apache DevLake Helm Chart 使用教程

incubator-devlake-helm-chartApache DevLake Helm Chart项目地址:https://gitcode.com/gh_mirrors/in/incubator-devlake-helm-chart

1. 项目的目录结构及介绍

Apache DevLake Helm Chart 项目的目录结构如下：

incubator-devlake-helm-chart/
├── charts/
│   └── devlake/
│       ├── asf.yaml
│       ├── .gitignore
│       ├── .gitmodules
│       ├── HelmSetup.md
│       ├── LICENSE
│       ├── README.md
│       ├── ReleaseSOP.md
│       └── values.yaml
├── .github/
│   └── workflows/
│       └── helm-chart.yml
├── templates/
│   ├── NOTES.txt
│   ├── _helpers.tpl
│   ├── deployment.yaml
│   ├── ingress.yaml
│   ├── service.yaml
│   └── serviceaccount.yaml
├── Chart.yaml
└── values.yaml

目录结构介绍

• charts/: 包含子Chart的目录。
• charts/devlake/: 主要的Chart目录，包含Chart的配置文件和文档。
• .github/workflows/: GitHub Actions 的工作流配置文件。
• templates/: Helm Chart 模板文件，用于生成 Kubernetes 资源文件。
• Chart.yaml: Helm Chart 的元数据文件。
• values.yaml: Helm Chart 的默认配置文件。

2. 项目的启动文件介绍

Chart.yaml

Chart.yaml 文件包含了 Helm Chart 的元数据信息，例如 Chart 的名称、版本、描述等。

apiVersion: v2
name: devlake
description: A Helm chart for Apache DevLake
version: 1.0.1-beta5
appVersion: 1.0.1-beta5

values.yaml

values.yaml 文件包含了 Helm Chart 的默认配置值，这些值可以在安装或升级 Chart 时被覆盖。

replicaCount: 1
image:
  repository: apache/devlake
  tag: latest
  pullPolicy: IfNotPresent

templates/deployment.yaml

templates/deployment.yaml 文件定义了 Kubernetes Deployment 资源，用于部署应用。

apiVersion: apps/v1
kind: Deployment
metadata:
  name: {{ .Release.Name }}-devlake
spec:
  replicas: {{ .Values.replicaCount }}
  template:
    spec:
      containers:
      - name: devlake
        image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}"
        imagePullPolicy: {{ .Values.image.pullPolicy }}

3. 项目的配置文件介绍

values.yaml

values.yaml 文件是 Helm Chart 的主要配置文件，包含了各种配置选项的默认值。

replicaCount: 1
image:
  repository: apache/devlake
  tag: latest
  pullPolicy: IfNotPresent
service:
  type: ClusterIP
  port: 80
ingress:
  enabled: false
  hosts:
    - host: chart-example.local
      paths:
        - /

templates/_helpers.tpl

templates/_helpers.tpl 文件包含了模板助手函数，用于在模板文件中生成动态内容。

{{- define "devlake.fullname" -}}
{{- if .Values.fullnameOverride }}
{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }}
{{- else }}
{{- $name := default .Chart.Name .Values.nameOverride }}
{{- if contains $name .Release.Name }}
{{- .Release.Name | trunc 63 | trimSuffix "-" }}
{{- else }}
{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" }}
{{- end }}
{{- end }}
{{- end }}

通过以上介绍，您可以更好地理解和使用 Apache DevLake Helm Chart 项目。希望这份文档对您有所帮助。

incubator-devlake-helm-chartApache DevLake Helm Chart项目地址:https://gitcode.com/gh_mirrors/in/incubator-devlake-helm-chart