Skip to main content

FluxCD

FluxCD 是一套面向 Kubernetes 的持续渐进式交付解决方案，具有开放性和可扩展性。

使用 Port 的 Kubernetes Exporter，您可以跟踪集群中的所有 Flux 资源，并将受监控的存储库和应用程序导出到 Port。 您将使用 kubernetes 资源和 CRD 的内置元数据在 Port 中创建实体，并跟踪其状态。

我们的 Kubernetes 输出程序基础知识 了解我们的 Kubernetes 输出程序基础知识here!

先决条件​

  • Helm must be installed to use the chart. Please refer to Helm's documentation to get started;
  • The jq command must installed;
  • The yq command must installed;
  • The kubectl command must be installed;
  • Have your Port credentials ready.

In this use-case, you will use a custom bash script which will assist you in the process of installing Port's K8s exporter.

The script will install the helm chart to the Kubernetes cluster which is currently in kubectl context. To view the context name of the cluster the exporter will be installed on, run:

kubectl config current-context

设置蓝图和资源映射​

下文将指导您使用安装脚本设置蓝图和资源映射。您可以阅读有关安装脚本的更多信息here 。

创建蓝图​

安装脚本提供了一种创建蓝图的便捷方法。 使用 CUSTOM_BP_PATH 环境变量，您可以获取预定义的 blueprints.json 来创建蓝图。 在本例中，您将使用this file 来定义蓝图。请通过运行

export CUSTOM_BP_PATH="https://github.com/port-labs/template-assets/blob/main/kubernetes/blueprints/fluxcd-blueprints.json"

该 blueprints.json 文件定义了以下蓝图:

  • 集群
  • namespace
  • 节点
  • 节点
  • 复制集
  • 工作量
  • 流量源
  • 流量应用
蓝图信息
  • Workload "是创建和管理 pod 的 Kubernetes 对象的抽象。 通过创建该蓝图，可以避免为每种工作负载类型创建专用蓝图，因为所有这些蓝图都可能 看起来非常相似。 以下是 "Workload "将代表的 kubernetes 对象列表:
    • 部署
    • 状态集
    • 守护进程集
  • Flux Source "是最重要的 Flux 资源之一，它定义了包含系统所需状态的资源库的来源以及获取该资源库的要求。该蓝图跟踪 Flux 系统中的 GitRepository 和 HelmRepository CRD。
  • Flux Application 是另一个重要的 Flux 资源，它代表 Flux 应该在集群中调和的一组本地 Kubernetes 资源。该蓝图跟踪 Flux 系统中的Kustomize和HelmRelease CRD。

导出自定义资源映射​

使用 CONFIG_YAML_URL 参数，可以定义自定义资源映射，以便在安装导出程序时使用。

在本例中，您将被用于 ** this configuration file**。为此，请运行

export CONFIG_YAML_URL="https://github.com/port-labs/template-assets/blob/main/kubernetes/templates/fluxcd-kubernetes_v1_config.yaml"

现在，您可以使用以下代码片段运行安装脚本:

export CLUSTER_NAME="my-cluster"
export PORT_CLIENT_ID="my-port-client-id"
export PORT_CLIENT_SECRET="my-port-client-secret"
curl -s https://raw.githubusercontent.com/port-labs/template-assets/main/kubernetes/install.sh | bash

现在您可以浏览您的 Port 环境，查看蓝图是否已创建，您的 k8s 和 Flux 资源是否正在使用新安装的 k8s 导出器向 Port 报告。

安装脚本如何工作？​

Port's K8s exporter installation script will assist you in the process of installing Port's K8s exporter template using helm chart.

This script will help you with:

tip

You can view the bash script here.

General installation configuration​

The script supports configuration via environment variables.

For each variable you'd like to set, run the following command before running the script:

export {VARIABLE_NAME}={value}
Environment VariableDescriptionDefault
PORT_CLIENT_IDRequired - Your Port organization's Client ID used to authenticate the exporter to Port
PORT_CLIENT_SECRETRequired - Your Port organization's Client Secret used to authenticate the exporter to Port
CUSTOM_BP_PATHRequired - The URL/path to a json file with an array of blueprint objects to create. Can be either a https://domain.com/path/to/blueprint.json format URL, or a local path to a file envs/production/blueprint.json.
CONFIG_YAML_URLRequired - The URL/path to the desired integration resource mapping. Can be either an https format URLhttps://domain.com/path/to/config.yaml, or a local path to a file envs/production/config.yamlhttps://github.com/port-labs/template-assets/blob/main/kubernetes/kubernetes_config.yaml
TARGET_NAMESPACEOptional - The Kubernetes namespace in which the exporter will be installedport-k8s-exporter
DEPLOYMENT_NAMEOptional - The Kubernetes deployment name the exporter will be installed asport-k8s-exporter
CLUSTER_NAMEOptional - The cluster's name as it will be exported to. Check out the note bellow for more information.my-cluster
note
  • CLUSTER_NAME: The script will set the cluster's name as the CLUSTER_NAME environment variable. This name will be used as the cluster's name in integration resources configuration. If you'd like to change the cluster's name, you can do so by setting the CLUSTER_NAME environment variable before running the script.
  • CUSTOM_BP_PATH: It is important to order the blueprints while taking in to account the necessary relations for each blueprint. Once a blueprint was created, attempting to recreate it using the script will fail. To recreate a blueprint using the script, first delete the blueprint.