Kubernetes

Kubernetes 是一个用于部署、扩缩和管理容器化应用的容器编排引擎。安装并启用适用于 GoLand 的 Kubernetes 插件，以添加以下用于管理 Kubernetes 集群的功能：

为 Kubernetes 资源配置文件提供代码辅助功能。
为 Helm 图表与模板提供代码辅助功能。有关更多信息，请参阅专用 Helm 页面。
通过自定义资源定义（CRD）规范验证自定义资源。
为 Kustomize 文件提供代码辅助功能：字段与本地文件路径补全、快速文档，以及 Kustomize 文件与补丁之间的导航。关联的 Kustomize 文件列表显示在编辑器中打开补丁文件的顶部。
在 GoLand 中与集群交互：使用 Services 工具窗口查看 Kubernetes 集群的所有资源、跳转至相关资源定义、查看 pod 中容器的日志等等。

Kubernetes 插件支持 Kubernetes 1.16 至 1.33 版本（您可以选择适用版本）。

安装 Kubernetes 插件

此功能依赖于 Kubernetes 插件，您需要安装并启用该插件。

按 Ctrl+Alt+S 打开设置，然后选择插件。
打开 Marketplace 选项卡，找到 Kubernetes 插件，然后点击安装（若提示，请重启 IDE）。

指定 kubectl 的自定义路径

GoLand 使用由 PATH 环境变量决定的默认 kubectl（以及如需使用的 helm ）可执行文件。

如果在自定义目录中安装了 kubectl，您可以手动指定其路径。

在设置对话框（Ctrl+Alt+S ）中，选择构建、执行、部署 | Kubernetes。
在 kubectl 可执行文件路径字段中，指定 kubectl 可执行文件的路径。
点击测试检查文件位置。如果未找到该文件，您可以手动检查文件位置，或点击安装，GoLand 将下载并安装缺失的软件。

使用自定义 Kubernetes 配置文件

集群的信息保存在 kubeconfig 文件中。 GoLand 会检测默认的 kubeconfig 文件，通常位于 $HOME/.kube/config （该位置可通过 KUBECONFIG 环境变量更改）。如果希望 GoLand 从自定义 kubeconfig 文件中获取集群信息（而不仅是默认文件），可以在 IDE 设置中进行指定。您可以选择全局应用该设置，也可以为每个项目使用不同的文件。

在设置对话框（Ctrl+Alt+S ）中，选择构建、执行、部署 | Kubernetes。
在配置下，点击并指定一个 kubeconfig 文件的路径。
如果希望在所有项目中使用该配置文件，请在作用域列中选择全局。若只在当前项目中使用，请保留项目范围。

添加文件后，GoLand 将验证其语法，并报告任何错误。

配置 Kubernetes API 版本

GoLand 提供配置键值的自动补全、通过图标跳转到相关选择器和定义、检查已弃用值和必需键的相关检查功能，以及其他辅助功能。这些功能依赖于您所使用的 API 版本。 Kubernetes 插件支持 Kubernetes 1.16 到 1.33 版本。默认情况下，GoLand 设置使用最新版本。但是，如果您的资源使用的是较早版本，您可以更换该版本。

在设置对话框（Ctrl+Alt+S ）中，选择语言与框架 | Kubernetes。
根据需要更改 Kubernetes API 版本和 Kustomize 版本选项。

资源配置文件

Kubernetes 插件对 YAML 格式的资源配置文件提供丰富支持，而对 JSON 格式仅提供基本支持。

支持的功能

功能	YAML	JSON
自动补全	支持	支持
	支持	支持
代码检查与快速修复	无效、缺失或重复的键不可编辑（只读）的键与资源已弃用的键与资源无效的整数及枚举键值	无效、缺失或重复的属性
实时模板	常见资源类型的预定义模板	无预定义实时模板
智能补全	支持	不支持
自定义资源定义	支持	不支持
标签定义与选择器	使用图标导航、查找用法与重命名	不支持
原始 Kubernetes 模型的增强	在适用场景下使用枚举替代普通字符串	无

GoLand 通过以下必需字段识别 Kubernetes 资源配置文件：

apiVersion ：标识对象表示的版本架构
kind ：标识资源类型（例如， Service、 Pod、 Deployment 等）

如果 YAML 或 JSON 文件中同时包含上述两个字段，GoLand 将用相应的 Kubernetes 图标标记该文件，并启用所有可用功能。

创建资源文件

借助 GoLand，您可以快速为 Kubernetes 中一些最常用的资源创建配置文件。

在项目工具窗口 Alt+1 中，右键点击文件夹，选择新建或按下 Alt+Insert ，然后选择 Kubernetes 资源。
在名称字段中，输入资源名称并从列表中选择文件模板。
这将基于所选的文件模板创建一个新文件及其内容。
点击在集群中创建资源。要更改目标集群，请点击。

或者，您也可以在 YAML 文件中使用预定义的 live templates ，例如：

kconfigmap ：Kubernetes ConfigMap
kcronjob ：Kubernetes CronJob
kdeployment ：Kubernetes Deployment
kingress ：Kubernetes Ingress
kpod ：Kubernetes Pod
kresource ：Kubernetes 从头开始的资源
kservice ：Kubernetes Service

禁用 Kubernetes 架构验证

GoLand 会根据 Kubernetes API 架构验证您的 Kubernetes 文件。这包括检查是否包含所需键或可能的资源类型。

如果您的文件包含 apiVersion 和 kind ，但它不是 Kubernetes 文件，您可以禁用此类验证。您可以在设置 | 编辑器 | 检查 | Kubernetes 中抑制检查并更改其范围与严重性。或者，您也可以通过添加特殊指令标记文件，从而在其中禁用验证：

在文件开头添加 # nonk8s。
或者，如果您已有有关未知资源的警告，请在问题工具窗口中右键点击该资源，并选择显示快速修复 | 将此文件标记为非 Kubernetes 文件。

管理集群

使用 Services 工具窗口查看集群、切换命名空间，并修改集群资源。

添加集群

要与 Kubernetes 集群交互，请在服务工具窗口中添加集群。

打开 Services 工具窗口：选择视图(V) | 工具窗口(T) | 服务或按下 Alt+8。
在服务工具窗口中右键点击 Kubernetes 节点，并选择添加集群。或者，点击并选择 Kubernetes | 添加集群。
接下来，选择要添加 Kubernetes 集群的来源：
- 来自默认目录：从默认位置获取集群（通常是 $HOME/.kube/config）。
- 来自自定义 kubeconfig ：从计算机中选择任意 kubeconfig 文件。
- 粘贴 kubeconfig 内容：将 kubeconfig 的内容粘贴到打开的文本区域中。
在打开的添加集群窗口中，选择要添加的集群并点击添加集群。

已添加的 Kubernetes 集群将在服务工具窗口中可用。右键点击某个集群并选择在新标签页中打开，即可在单独标签页中打开它们。

若要实时监视集群资源，您可以连接到集群。

连接到集群

连接到集群以在 IDE 中与其交互：查看日志、预览资源、查看其配置文件，并在其被修改时获取实时更新。在未连接到集群的情况下，您可以在编辑器中修改其资源。

打开服务工具窗口：选择视图(V) | 工具窗口(T) | 服务或按 Alt+8。
如果服务工具窗口中没有集群，请添加一个集群。
右键点击某个集群并选择连接集群。

编辑 kubeconfig

kubeconfig 文件包含有关集群、用户、命名空间和身份验证的信息。

打开服务工具窗口：选择视图(V) | 工具窗口(T) | 服务或按 Alt+8。
选择一个集群并点击工具栏上的（在编辑器中打开kubeconfig 文件）。在服务工具窗口中右键点击任意 Kubernetes 对象时也可执行此操作。
这将在编辑器的新标签页中打开 kubeconfig 文件。要更改此操作默认打开的文件，您可以在 kubeconfig 文件路径中指定其他文件路径。

修改 kubeconfig 文件后，配置将自动重新加载。您也可以手动重新加载，或通过右键点击某个集群或任意 Kubernetes 对象并选择更多(M) | 自动重新加载配置来禁用自动重新加载。

在命名空间之间切换

Kubernetes 命名空间允许在集群中逻辑隔离资源。使用 GoLand，您可以快速切换命名空间。

打开服务工具窗口：选择视图(V) | 工具窗口(T) | 服务或按 Alt+8。
右键点击您的集群或任意资源，选择命名空间（或点击工具栏上的），然后选择所需的命名空间。
若要查看所有命名空间的资源，请选择所有命名空间。

选择当前集群

当前集群是指在编辑器和项目工具窗口中与资源交互时默认使用的集群。

在本地修改或创建资源文件时，您可以点击选择要应用资源的集群。您也可以提前进行选择。

打开服务工具窗口：选择视图(V) | 工具窗口(T) | 服务或按 Alt+8。
右键点击集群并选择将集群设为当前集群。
或者，选择一个集群并在工具栏中点击。

此设置也可在 IDE 设置中的语言与框架 | Kubernetes 下找到。

修改集群资源

打开服务工具窗口：选择视图(V) | 工具窗口(T) | 服务或按 Alt+8。
右键点击资源并选择查看YAML。
这将在编辑器的新选项卡中打开所选资源的配置文件。更改字段时，更改的行会在边栏中高亮显示。您可以点击边栏中高亮区域，以快速预览或回滚更改。
点击应用对当前集群和命名空间的更改。

修改资源配置文件时，右上角会显示一个工具栏。该工具栏允许您应用更改、删除资源、预览差异以及回滚更改。

查看资源详情

GoLand 可让您无需手动执行任何命令即可快速查看 Kubernetes 资源的详细信息。

在服务工具窗口中，选择一个资源以查看其详细信息。

删除资源

您可以通过以下任一方式删除资源：

在服务工具窗口中，右键点击资源并选择删除(当前集群未配置)。
在服务工具窗口中，选择一个资源并在工具栏中点击（删除资源）。
如果资源 YAML 文件已在编辑器中打开，将鼠标悬停于文件上并点击。您也可以点击此处的来更改要删除资源的集群。

端口转发

借助 Kubernetes 中的端口转发，您可以将计算机上的本地端口流量重定向到 Kubernetes pod 上的端口。 GoLand 可帮助您管理端口转发：您可以将一个或多个本地端口转发到远程端口，查看集群中所有活动转发会话（由 GoLand 建立），停止和重启转发会话。

打开服务工具窗口：选择视图(V) | 工具窗口(T) | 服务或按 Alt+8。右键点击目标 pod 并选择转发端口。
在转发端口对话框中：
- 在地址字段中列出要监听的地址。使用逗号分隔多个值。
- 在端口字段中，以 <local port>:<remote port> 格式指定端口。例如， 8888:5000 表示监听本地端口 8888 并将数据转发至远程端口 5000。
  GoLand 会根据相应 Kubernetes 清单中定义的值自动建议端口映射。如果清单指定的端口已被本地机器占用，GoLand 会递增建议值直到找到可用端口。
  如果指定的值小于 1024 ，将给建议的本地端口值增加 8000。
  如果手动指定的本地端口当前已被占用，在开始转发之前，GoLand 会提醒您。
点击转发。

管理端口转发会话

要查看所有活动的端口转发会话，请在服务工具窗口中展开 Kubernetes 集群中的网络 | 端口转发。
要终止端口转发会话，右键点击并选择停止端口转发，或在工具栏中点击。
要重启端口转发会话，右键点击并选择重新启动端口转发，或在工具栏中点击。

创建密文

使用 GoLand，您可以快速创建 Kubernetes Secret。

打开服务工具窗口：选择视图(V) | 工具窗口(T) | 服务或按 Alt+8。
选择一个集群并展开配置。
右键点击机密节点并选择创建新密钥。或者，选择机密节点并在工具栏中点击。
在打开的创建新密钥窗口中，指定 Secret 的名称、类型和命名空间。为加快创建 Secret 的速度，GoLand 会根据所选 Secret 类型添加所需的数据或注解键。
在数据和注解部分，点击值并为现有键输入值，或者点击并选择提供值的方式：
- 手动添加用于手动输入值。
- 使用文件数据选择一个文件（例如 SSH 密钥文件或 Docker config.json ），并使用其内容作为值。

您可以在服务工具窗口中的配置下查看所有 Secret。要编辑 Secret，请右键点击它并选择编辑机密，或在工具栏中点击。

创建 Secret 后，您可以在 Pod 配置文件的 secretName 字段中开始输入该名称。这将触发当前集群或项目中可用的 Secret 名称补全。

保持集群信息为最新

为使 GoLand 保持与您的集群同步，请使用以下操作：

重新加载配置以获取 kubeconfig 文件中的最新更改。
刷新资源以获取 Kubernetes 资源的最新更改。如果您具有必要的权限，通常会自动完成此操作。

重新加载配置

默认情况下，当您更改 kubeconfig 文件时，配置会自动重新加载。您仍然可以手动重新加载。

打开 Services 工具窗口：选择视图(V) | 工具窗口(T) | 服务或按下 Alt+8。
右键点击某个集群并选择更多 | 重新加载配置。

如果您要禁用自动重新加载，请取消选中自动重新加载配置选项。

您也可以在 IDE 设置（Ctrl+Alt+S ）中，查看构建、执行、部署 | Kubernetes | 自动重新加载配置中的相关设置。

手动刷新集群资源

如果您已连接到集群，对其资源所做的更改将自动反映在 IDE 中。如果资源未自动更新（由于您的 cluster role 缺少相应权限），将在服务工具窗口中显示有关自动刷新被禁止的消息。在这种情况下，您可以手动刷新资源。

打开服务工具窗口：选择视图(V) | 工具窗口(T) | 服务或按 Alt+8。
右键点击资源组并选择刷新或点击 Ctrl+F5。

查看日志

使用 GoLand，您可以查看集群日志及所选资源的日志。您可以按日期、来源以及日志消息中的特定值进行筛选。

在编辑器中打开资源日志

打开服务工具窗口：选择视图(V) | 工具窗口(T) | 服务或按 Alt+8。
通过以下方式之一选择日志来源：
- 若要查看所有资源的日志，请选择 Kubernetes 集群并点击（关注日志），位于服务工具窗口的工具栏上。
- 若要查看特定资源的日志，请选择该资源并点击（关注日志），位于服务工具窗口的工具栏上。或者，右键点击资源并选择关注日志。
  如果 pod 中存在多个容器，请从显示的容器列表中选择您要跟踪日志的容器。

这将使用 --follow=true 标志对所选资源的日志进行实时跟踪，并在新编辑器标签页中打开。

管理日志

在查看集群日志或所选资源日志时，您可以使用主工具栏（1）或浮动工具栏（2）处理日志输出。浮动工具栏提供对常用操作的快速访问。

（滚动到末尾）：跳转到日志输出末尾。
（自动换行）：当编辑器大小调整时，为日志条目启用软换行。
（下载筛选后的日志）：下载当前在编辑器中打开的日志，考虑应用的筛选条件。
（清除显示的日志）：清除编辑器中显示的日志条目。该操作仅影响当前视图。当您重新打开相同资源的日志时，条目将重新出现。

筛选日志

打开日志后，您可以使用编辑器顶部的以下筛选器优化日志列表：

（打开模式匹配）：输入或选择您希望日志数据匹配的值或模式。例如，如果日志中包含 level 信息，您可以选择 warn、 error 或其他级别值，以仅显示这些级别的日志。
（选择日志来源）：选择要显示日志的集群资源。
（按日期和时间筛选）：选择要显示日志的时间范围。
（选择日志字段）：选择是否显示日志的时间戳、来源和消息内容。
您可以在 IDE 设置（Ctrl+Alt+S ）中的构建、执行、部署 | Kubernetes | 日志 | 日志中默认显示的字段下全局配置日志字段的可见性。
在编辑器选项卡顶部的输入字段中输入日志消息中的值。单击以使用正则表达式，单击以启用区分大小写的搜索。

（清除所有日志筛选器）：清除所有已应用的过滤器（来源除外），并显示所有日志。

下载单个容器的日志

打开服务工具窗口：选择视图(V) | 工具窗口(T) | 服务或按 Alt+8。
选择一个资源，然后单击右侧工具栏中的（下载日志）以保存日志文件。

配置日志保存选项

您可以在 IDE 设置（Ctrl+Alt+S ）中的构建、执行、部署 | Kubernetes | 日志下配置日志保存选项：

如果想要将日志保存在 Scratches 之外的位置，请在下载日志的路径中指定目录。或者选择下载前询问日志的保存位置，每次保存日志时提示输入位置。
如果希望在文件名中包含日志的时间戳，请选择将时间戳附加到日志文件名。

自定义资源定义支持

如果您通过自定义资源扩展 Kubernetes 集群，GoLand 可使用自定义资源定义（CRD）规范对其进行校验。

指定 CRD 规范路径

按下 Ctrl+Alt+S 打开设置，然后选择语言与框架 | Kubernetes。
单击，然后选择本地 CRD 文件或指定一个 URL。然后单击确定(O)。

使用和重新排列 CRD 文件列表。这将定义存在冲突的定义的优先级：如果在多个文件中定义，则 GoLand 将使用优先级最低的那个。

默认情况下，CRD 仅应用于当前项目。如果希望某个 CRD 在使用此 IDE 实例打开的任何项目中都可用，请将作用域：选项更改为 IDE。

要从正在运行的 Kubernetes 集群加载 CRD，请启用使用活动集群中的API 架构(如果可用)。

您可以在 Kubernetes 节点下的服务工具窗口中查看当前集群的 CRD，包括其所有应用资源。

Kubernetes 插件支持以下类型的 CRD 文件：

YAML 格式的 CustomResourceDefinition 文件

以下示例展示了一个简单的 CustomResourceDefinition 规范，用于自定义资源 stable.example.com/v1 的类型 CronTab。用于标识此资源的必需字段为 metadata.name、 spec.group、 spec.versions 和 spec.names。

                apiVersion: apiextensions.k8s.io/v1beta1
                kind: CustomResourceDefinition
                metadata:
                  name: crontabs.stable.example.com # Obligatory field to identify the resource
                spec:
                  group: stable.example.com # Obligatory field to identify the resource
                  versions: # Obligatory field to identify the resource
                    - name: v1
                      served: true
                      storage: true
                  scope: Namespaced
                  names: # Obligatory field to identify the resource
                    plural: crontabs
                    singular: crontab
                    kind: CronTab
                    shortNames:
                      - ct
                validation:
                  openAPIV3Schema: # Schema for validating custom objects
                    properties:
                      spec:
                        properties:
                          cronSpec:
                            type: string
                            pattern: '^(\d+|\*)(/\d+)?(\s+(\d+|\*)(/\d+)?){4}$' # not supported for validation
                          replicas:
                            type: integer
                            minimum: 1 # not supported for validation
                            maximum: 10 # not supported for validation
            
   

JSON 中的 OpenAPI v2.0 架构

以下示例展示了一个包含自定义资源 sample/v1 的 CRD 规范的简单 OpenAPI v2.0 架构，该资源类型为 Config。自定义资源的根定义必须包含带有指定 group、version 和 kind 的 x-kubernetes-group-version-kind 字段。在该示例中， root.Definition 对象使用 build 属性引用 some.Definition 对象。

                {
                    "swagger": "2.0",
                    "info": {
                        "title": "Sample Schema",
                        "version": "sample/v1"
                    },
                    "paths": {},
                    "definitions": {
                        "some.Definition": {
                            "description": "Example of a definition.",
                            "properties": {
                                "someProperty": {
                                    "type": "string"
                                }
                            }
                        },
                        "root.Definition": {
                            "description": "This is the root definition for the resource",
                            "properties": {
                                "build": {
                                    "$ref": "#/definitions/some.Definition"
                                }
                            },
                            "x-kubernetes-group-version-kind": [
                                {
                                    "group": "sample",
                                    "kind": "Config",
                                    "version": "v1"
                                }
                            ]
                        }
                    }
                }
            
   

CRD 验证限制

GoLand 不支持以下 OpenAPI v3 架构功能：

multipleOf
maximum
exclusiveMaximum
minimum
exclusiveMinimum
maxLength
minLength
pattern
maxItems
minItems
uniqueItems
maxProperties
minProperties
allOf
oneOf
anyOf
not
format
default
nullable
readOnly
writeOnly
xml
externalDocs
example
deprecated

效率技巧

如果您经常使用此处描述的功能，以下提示可能会有所帮助：

分配快捷键

您可以为 Kubernetes 操作分配快捷键。

在设置对话框（Ctrl+Alt+S ）中，选择按键映射。
在搜索字段中输入 kubernetes ，然后双击某个操作为其设置快捷键。

或者，您可以使用查找操作对话框 Ctrl+Shift+A ，输入所需操作并按 Alt+Enter。

例如，您可以为与集群交互分配快捷键，以便在修改资源配置文件时快速打开上下文菜单。

配置代码折叠

默认情况下，GoLand 使用代码折叠将 Helm 模板中的值引用和 Kubernetes 配置文件中的定义渲染为实际值。您可以点击该值将其展开，或按 Ctrl+NumPad + 和 Ctrl+NumPad - 切换折叠状态。如果希望默认展开引用和值定义，请执行以下操作：

在设置对话框（Ctrl+Alt+S ）中，选择编辑器 | 常规 | 代码折叠。
在代码折叠页面上，取消选中所需的复选框：
- Kubernetes：Helm 模板中的值引用
- Kubernetes：YAML 文件中的 EnvVar 定义
- Kubernetes：YAML 文件中的 ExecAction 定义

最后修改日期： 2025年 9月 26日