Skip to content

Commit d6dc424

Browse files
adityathebemoshloop
authored andcommitted
docs: Kubernetes connection ref
1 parent 387a5ee commit d6dc424

File tree

2 files changed

+120
-8
lines changed

2 files changed

+120
-8
lines changed

common/src/components/Fields.jsx

+22-8
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ export default function Fields({ common = [], rows = [], oneOf, anyOf, connectio
7070
(row.field != "artifacts" || !oss));
7171

7272

73-
var fieldSorter = function (a, b) {
73+
var fieldSorter = function(a, b) {
7474
if (a.required && !b.required) {
7575
return -1;
7676
}
@@ -192,10 +192,12 @@ export default function Fields({ common = [], rows = [], oneOf, anyOf, connectio
192192
},
193193
{
194194
field: "accessKey",
195+
description: "",
195196
scheme: "EnvVar"
196197
},
197198
{
198199
field: "secretKey",
200+
description: "",
199201
scheme: "EnvVar"
200202
},
201203
{
@@ -205,6 +207,7 @@ export default function Fields({ common = [], rows = [], oneOf, anyOf, connectio
205207
},
206208
{
207209
field: "endpoint",
210+
scheme: "string",
208211
description: "Custom AWS Endpoint to use",
209212
},
210213
{
@@ -216,14 +219,25 @@ export default function Fields({ common = [], rows = [], oneOf, anyOf, connectio
216219
} else if (connection == "gcp") {
217220
rows = rows.concat([
218221
{
219-
field: oss ? null : "connection",
220-
description: "The connection url to use, mutually exclusive with `credentials`",
221-
scheme: "Connection",
222+
field: oss ? null : 'connection',
223+
description:
224+
'The connection url to use, mutually exclusive with `credentials`',
225+
scheme: 'Connection'
222226
},
223227
{
224-
field: "credentials",
225-
description: "The credentials to use for authentication",
226-
scheme: "EnvVar"
228+
field: 'credentials',
229+
description: 'The credentials to use for authentication',
230+
scheme: 'EnvVar'
231+
},
232+
{
233+
field: 'endpoint',
234+
description: 'Custom GCP Endpoint to use',
235+
scheme: 'string'
236+
},
237+
{
238+
field: 'skipTLSVerify',
239+
description: 'Skip TLS verification when connecting to GCP',
240+
scheme: 'bool'
227241
}
228242
])
229243
} else if (connection == "sftp") {
@@ -368,7 +382,7 @@ export default function Fields({ common = [], rows = [], oneOf, anyOf, connectio
368382
},
369383
{
370384
field: "apiKey",
371-
description: "Anthropic API key for authentication",
385+
description: "Anthropic API key for authentication",
372386
scheme: "EnvVar",
373387
required: true
374388
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
---
2+
title: Kubernetes
3+
sidebar_custom_props:
4+
icon: k8s
5+
---
6+
7+
Kubernetes connections enable integration with Kubernetes clusters across different cloud providers and environments.
8+
You can configure connections to AWS EKS clusters, Google Cloud GKE instances, and Config Connector (CNRM) implementations.
9+
10+
<Fields connection="kubernetes" rows={[
11+
{
12+
field: "connection",
13+
description: "The connection url to use, mutually exclusive with `kubeconfig`",
14+
scheme: "Connection",
15+
},
16+
{
17+
field: "kubeconfig",
18+
description: "Source for kubeconfig",
19+
scheme: "EnvVar"
20+
},
21+
{
22+
field: "eks",
23+
description: "EKS connection details",
24+
scheme: "[EKS](#eks-connection)",
25+
},
26+
{
27+
field: "gke",
28+
description: "GKE connection details",
29+
scheme: "[GKE](#gke-connection)",
30+
},
31+
{
32+
field: "cnrm",
33+
description: "CNRM connection details",
34+
scheme: "[CNRM](#cnrm-connection)",
35+
}
36+
]}
37+
/>
38+
39+
:::note
40+
One of the four sources of connection details must be provided.
41+
:::
42+
43+
### EKS Connection
44+
45+
<Fields connection="aws" rows={[
46+
{
47+
field: "cluster",
48+
description: "Name of the cluster",
49+
scheme: "string",
50+
required: true,
51+
}
52+
]}
53+
/>
54+
55+
### GKE Connection
56+
57+
<Fields connection="gcp" rows={[
58+
{
59+
field: "project",
60+
description: "Name of the project",
61+
scheme: "string",
62+
required: true,
63+
},
64+
{
65+
field: "zone",
66+
description: "Name of the zone",
67+
scheme: "string",
68+
required: true,
69+
},
70+
{
71+
field: "cluster",
72+
description: "Name of the cluster",
73+
scheme: "string",
74+
required: true,
75+
}
76+
]}
77+
/>
78+
79+
### CNRM Connection
80+
81+
<Fields connection="cnrm" rows={[
82+
{
83+
field: "gke",
84+
description: "GKE connection",
85+
scheme: "[GKE](#gke-connection)",
86+
},
87+
{
88+
field: "clusterResource",
89+
description: "Name of the cluster resource",
90+
scheme: "string",
91+
},
92+
{
93+
field: "clusterResourceNamespace",
94+
description: "Namespace of the cluster resource",
95+
scheme: "string",
96+
}
97+
]}
98+
/>

0 commit comments

Comments
 (0)