Skip to main content

Kubernetes(扩展自)

本用例是basic Kubernetes use-case 的扩展。如果您还没有阅读，建议您先阅读本用例。

Kubernetes 已成为部署基于微服务的应用程序的最流行方式之一。 随着微服务数量的增长，以及在多个区域部署更多集群，跟踪所有部署、服务和作业变得复杂而乏味。

使用 Port 的 Kubernetes Exporter，您可以跟踪 K8s 资源并将所有数据导出到 Port。 您将使用 K8s 内置的元数据在 Port 中创建实体并跟踪其状态。

了解 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://raw.githubusercontent.com/port-labs/template-assets/main/kubernetes/blueprints/kubernetes_complete_usecase_bps.json"

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

  • 集群；
  • namespace；
  • 节点
  • Pod
  • 复制集
  • 工作负载 *；
note
  • Workload "是创建和管理 pod 的 Kubernetes 对象的抽象。通过创建该蓝图，可以避免为每种工作负载类型创建一个专用蓝图，因为所有这些蓝图可能看起来都非常相似。 以下是 "Workload "将代表的 kubernetes 对象列表:
    • 部署；
    • StatefulSet；
    • DaemonSet。

导出自定义资源映射​

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

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

export CONFIG_YAML_URL="https://raw.githubusercontent.com/port-labs/template-assets/main/kubernetes/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 导出器报告到 Port。

摘要​

在这种被用于的情况下，您可以使用安装脚本:

  • 通过创建定义不同 k8s 资源的蓝图来设置 Port 环境；
  • 通过配置安装 Port 的 k8s 导出器，以便从集群导出重要数据；
  • 将集群中的 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.