@robinmordasiewicz/f5xc-api-mcp 3.3.0 → 3.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/generator/openapi-parser.d.ts +418 -0
- package/dist/generator/openapi-parser.d.ts.map +1 -1
- package/dist/generator/openapi-parser.js +132 -0
- package/dist/generator/openapi-parser.js.map +1 -1
- package/dist/generator/tool-generator.d.ts +29 -1
- package/dist/generator/tool-generator.d.ts.map +1 -1
- package/dist/generator/tool-generator.js +150 -7
- package/dist/generator/tool-generator.js.map +1 -1
- package/dist/tools/discovery/describe.d.ts +1 -0
- package/dist/tools/discovery/describe.d.ts.map +1 -1
- package/dist/tools/discovery/describe.js +10 -8
- package/dist/tools/discovery/describe.js.map +1 -1
- package/dist/tools/generated/admin_console_and_ui/index.d.ts +8 -0
- package/dist/tools/generated/admin_console_and_ui/index.d.ts.map +1 -0
- package/dist/tools/generated/admin_console_and_ui/index.js +285 -0
- package/dist/tools/generated/admin_console_and_ui/index.js.map +1 -0
- package/dist/tools/generated/api/index.d.ts +8 -0
- package/dist/tools/generated/{vpn → api}/index.d.ts.map +1 -1
- package/dist/tools/generated/api/index.js +6668 -0
- package/dist/tools/generated/api/index.js.map +1 -0
- package/dist/tools/generated/authentication/index.d.ts +8 -0
- package/dist/tools/generated/authentication/index.d.ts.map +1 -0
- package/dist/tools/generated/authentication/index.js +1005 -0
- package/dist/tools/generated/authentication/index.js.map +1 -0
- package/dist/tools/generated/bigip/index.d.ts.map +1 -1
- package/dist/tools/generated/bigip/index.js +2045 -0
- package/dist/tools/generated/bigip/index.js.map +1 -1
- package/dist/tools/generated/billing_and_usage/index.d.ts +8 -0
- package/dist/tools/generated/billing_and_usage/index.d.ts.map +1 -0
- package/dist/tools/generated/billing_and_usage/index.js +2702 -0
- package/dist/tools/generated/billing_and_usage/index.js.map +1 -0
- package/dist/tools/generated/blindfold/index.d.ts +8 -0
- package/dist/tools/generated/blindfold/index.d.ts.map +1 -0
- package/dist/tools/generated/blindfold/index.js +3998 -0
- package/dist/tools/generated/blindfold/index.js.map +1 -0
- package/dist/tools/generated/bot_and_threat_defense/index.d.ts +8 -0
- package/dist/tools/generated/bot_and_threat_defense/index.d.ts.map +1 -0
- package/dist/tools/generated/bot_and_threat_defense/index.js +2584 -0
- package/dist/tools/generated/bot_and_threat_defense/index.js.map +1 -0
- package/dist/tools/generated/cdn/index.d.ts.map +1 -1
- package/dist/tools/generated/cdn/index.js +1904 -0
- package/dist/tools/generated/cdn/index.js.map +1 -1
- package/dist/tools/generated/ce_management/index.d.ts +8 -0
- package/dist/tools/generated/ce_management/index.d.ts.map +1 -0
- package/dist/tools/generated/ce_management/index.js +3963 -0
- package/dist/tools/generated/ce_management/index.js.map +1 -0
- package/dist/tools/generated/certificates/index.d.ts +8 -0
- package/dist/tools/generated/certificates/index.d.ts.map +1 -0
- package/dist/tools/generated/certificates/index.js +2579 -0
- package/dist/tools/generated/certificates/index.js.map +1 -0
- package/dist/tools/generated/cloud_infrastructure/index.d.ts +8 -0
- package/dist/tools/generated/cloud_infrastructure/index.d.ts.map +1 -0
- package/dist/tools/generated/cloud_infrastructure/index.js +4124 -0
- package/dist/tools/generated/cloud_infrastructure/index.js.map +1 -0
- package/dist/tools/generated/container_services/index.d.ts +8 -0
- package/dist/tools/generated/container_services/index.d.ts.map +1 -0
- package/dist/tools/generated/container_services/index.js +2054 -0
- package/dist/tools/generated/container_services/index.js.map +1 -0
- package/dist/tools/generated/data_and_privacy_security/index.d.ts +8 -0
- package/dist/tools/generated/data_and_privacy_security/index.d.ts.map +1 -0
- package/dist/tools/generated/data_and_privacy_security/index.js +1708 -0
- package/dist/tools/generated/data_and_privacy_security/index.js.map +1 -0
- package/dist/tools/generated/data_intelligence/index.d.ts +8 -0
- package/dist/tools/generated/data_intelligence/index.d.ts.map +1 -0
- package/dist/tools/generated/data_intelligence/index.js +1770 -0
- package/dist/tools/generated/data_intelligence/index.js.map +1 -0
- package/dist/tools/generated/ddos/index.d.ts +8 -0
- package/dist/tools/generated/ddos/index.d.ts.map +1 -0
- package/dist/tools/generated/ddos/index.js +8511 -0
- package/dist/tools/generated/ddos/index.js.map +1 -0
- package/dist/tools/generated/dns/index.d.ts +8 -0
- package/dist/tools/generated/dns/index.d.ts.map +1 -0
- package/dist/tools/generated/dns/index.js +6460 -0
- package/dist/tools/generated/dns/index.js.map +1 -0
- package/dist/tools/generated/generative_ai/index.d.ts +8 -0
- package/dist/tools/generated/generative_ai/index.d.ts.map +1 -0
- package/dist/tools/generated/generative_ai/index.js +1215 -0
- package/dist/tools/generated/generative_ai/index.js.map +1 -0
- package/dist/tools/generated/managed_kubernetes/index.d.ts +8 -0
- package/dist/tools/generated/managed_kubernetes/index.d.ts.map +1 -0
- package/dist/tools/generated/managed_kubernetes/index.js +3233 -0
- package/dist/tools/generated/managed_kubernetes/index.js.map +1 -0
- package/dist/tools/generated/marketplace/index.d.ts +8 -0
- package/dist/tools/generated/marketplace/index.d.ts.map +1 -0
- package/dist/tools/generated/marketplace/index.js +4580 -0
- package/dist/tools/generated/marketplace/index.js.map +1 -0
- package/dist/tools/generated/network/index.d.ts +8 -0
- package/dist/tools/generated/network/index.d.ts.map +1 -0
- package/dist/tools/generated/network/index.js +12616 -0
- package/dist/tools/generated/network/index.js.map +1 -0
- package/dist/tools/generated/network_security/index.d.ts +8 -0
- package/dist/tools/generated/network_security/index.d.ts.map +1 -0
- package/dist/tools/generated/network_security/index.js +8884 -0
- package/dist/tools/generated/network_security/index.js.map +1 -0
- package/dist/tools/generated/nginx_one/index.d.ts +8 -0
- package/dist/tools/generated/nginx_one/index.d.ts.map +1 -0
- package/dist/tools/generated/nginx_one/index.js +1820 -0
- package/dist/tools/generated/nginx_one/index.js.map +1 -0
- package/dist/tools/generated/object_storage/index.d.ts +8 -0
- package/dist/tools/generated/object_storage/index.d.ts.map +1 -0
- package/dist/tools/generated/object_storage/index.js +1055 -0
- package/dist/tools/generated/object_storage/index.js.map +1 -0
- package/dist/tools/generated/observability/index.d.ts.map +1 -1
- package/dist/tools/generated/observability/index.js +4243 -4618
- package/dist/tools/generated/observability/index.js.map +1 -1
- package/dist/tools/generated/rate_limiting/index.d.ts +8 -0
- package/dist/tools/generated/rate_limiting/index.d.ts.map +1 -0
- package/dist/tools/generated/rate_limiting/index.js +1937 -0
- package/dist/tools/generated/rate_limiting/index.js.map +1 -0
- package/dist/tools/generated/secops_and_incident_response/index.d.ts +8 -0
- package/dist/tools/generated/secops_and_incident_response/index.d.ts.map +1 -0
- package/dist/tools/generated/secops_and_incident_response/index.js +653 -0
- package/dist/tools/generated/secops_and_incident_response/index.js.map +1 -0
- package/dist/tools/generated/service_mesh/index.d.ts.map +1 -1
- package/dist/tools/generated/service_mesh/index.js +4532 -438
- package/dist/tools/generated/service_mesh/index.js.map +1 -1
- package/dist/tools/generated/shape/index.d.ts +8 -0
- package/dist/tools/generated/shape/index.d.ts.map +1 -0
- package/dist/tools/generated/shape/index.js +21784 -0
- package/dist/tools/generated/shape/index.js.map +1 -0
- package/dist/tools/generated/sites/index.d.ts +8 -0
- package/dist/tools/generated/sites/index.d.ts.map +1 -0
- package/dist/tools/generated/sites/index.js +13252 -0
- package/dist/tools/generated/sites/index.js.map +1 -0
- package/dist/tools/generated/statistics/index.d.ts +8 -0
- package/dist/tools/generated/statistics/index.d.ts.map +1 -0
- package/dist/tools/generated/statistics/index.js +8837 -0
- package/dist/tools/generated/statistics/index.js.map +1 -0
- package/dist/tools/generated/support/index.d.ts +8 -0
- package/dist/tools/generated/support/index.d.ts.map +1 -0
- package/dist/tools/generated/support/index.js +6215 -0
- package/dist/tools/generated/support/index.js.map +1 -0
- package/dist/tools/generated/telemetry_and_insights/index.d.ts +8 -0
- package/dist/tools/generated/telemetry_and_insights/index.d.ts.map +1 -0
- package/dist/tools/generated/telemetry_and_insights/index.js +2773 -0
- package/dist/tools/generated/telemetry_and_insights/index.js.map +1 -0
- package/dist/tools/generated/tenant_and_identity/index.d.ts +8 -0
- package/dist/tools/generated/tenant_and_identity/index.d.ts.map +1 -0
- package/dist/tools/generated/tenant_and_identity/index.js +20456 -0
- package/dist/tools/generated/tenant_and_identity/index.js.map +1 -0
- package/dist/tools/generated/threat_campaign/index.d.ts +8 -0
- package/dist/tools/generated/threat_campaign/index.d.ts.map +1 -0
- package/dist/tools/generated/threat_campaign/index.js +112 -0
- package/dist/tools/generated/threat_campaign/index.js.map +1 -0
- package/dist/tools/generated/users/index.d.ts +8 -0
- package/dist/tools/generated/users/index.d.ts.map +1 -0
- package/dist/tools/generated/users/index.js +1572 -0
- package/dist/tools/generated/users/index.js.map +1 -0
- package/dist/tools/generated/virtual/index.d.ts +8 -0
- package/dist/tools/generated/virtual/index.d.ts.map +1 -0
- package/dist/tools/generated/virtual/index.js +11540 -0
- package/dist/tools/generated/virtual/index.js.map +1 -0
- package/dist/tools/generated/vpm_and_node_management/index.d.ts +8 -0
- package/dist/tools/generated/vpm_and_node_management/index.d.ts.map +1 -0
- package/dist/tools/generated/vpm_and_node_management/index.js +98 -0
- package/dist/tools/generated/vpm_and_node_management/index.js.map +1 -0
- package/dist/tools/generated/waf/index.d.ts +8 -0
- package/dist/tools/generated/waf/index.d.ts.map +1 -0
- package/dist/tools/generated/waf/index.js +4440 -0
- package/dist/tools/generated/waf/index.js.map +1 -0
- package/dist/tools/registry.d.ts.map +1 -1
- package/dist/tools/registry.js +68 -36
- package/dist/tools/registry.js.map +1 -1
- package/package.json +3 -1
- package/dist/tools/generated/ai_intelligence/index.d.ts +0 -8
- package/dist/tools/generated/ai_intelligence/index.d.ts.map +0 -1
- package/dist/tools/generated/ai_intelligence/index.js +0 -282
- package/dist/tools/generated/ai_intelligence/index.js.map +0 -1
- package/dist/tools/generated/api_security/index.d.ts +0 -8
- package/dist/tools/generated/api_security/index.d.ts.map +0 -1
- package/dist/tools/generated/api_security/index.js +0 -1852
- package/dist/tools/generated/api_security/index.js.map +0 -1
- package/dist/tools/generated/applications/index.d.ts +0 -8
- package/dist/tools/generated/applications/index.d.ts.map +0 -1
- package/dist/tools/generated/applications/index.js +0 -1589
- package/dist/tools/generated/applications/index.js.map +0 -1
- package/dist/tools/generated/billing/index.d.ts +0 -8
- package/dist/tools/generated/billing/index.d.ts.map +0 -1
- package/dist/tools/generated/billing/index.js +0 -759
- package/dist/tools/generated/billing/index.js.map +0 -1
- package/dist/tools/generated/config/index.d.ts +0 -8
- package/dist/tools/generated/config/index.d.ts.map +0 -1
- package/dist/tools/generated/config/index.js +0 -316
- package/dist/tools/generated/config/index.js.map +0 -1
- package/dist/tools/generated/identity/index.d.ts +0 -8
- package/dist/tools/generated/identity/index.d.ts.map +0 -1
- package/dist/tools/generated/identity/index.js +0 -5371
- package/dist/tools/generated/identity/index.js.map +0 -1
- package/dist/tools/generated/infrastructure/index.d.ts +0 -8
- package/dist/tools/generated/infrastructure/index.d.ts.map +0 -1
- package/dist/tools/generated/infrastructure/index.js +0 -5342
- package/dist/tools/generated/infrastructure/index.js.map +0 -1
- package/dist/tools/generated/infrastructure_protection/index.d.ts +0 -8
- package/dist/tools/generated/infrastructure_protection/index.d.ts.map +0 -1
- package/dist/tools/generated/infrastructure_protection/index.js +0 -2919
- package/dist/tools/generated/infrastructure_protection/index.js.map +0 -1
- package/dist/tools/generated/integrations/index.d.ts +0 -8
- package/dist/tools/generated/integrations/index.d.ts.map +0 -1
- package/dist/tools/generated/integrations/index.js +0 -1995
- package/dist/tools/generated/integrations/index.js.map +0 -1
- package/dist/tools/generated/load_balancer/index.d.ts +0 -8
- package/dist/tools/generated/load_balancer/index.d.ts.map +0 -1
- package/dist/tools/generated/load_balancer/index.js +0 -2269
- package/dist/tools/generated/load_balancer/index.js.map +0 -1
- package/dist/tools/generated/networking/index.d.ts +0 -8
- package/dist/tools/generated/networking/index.d.ts.map +0 -1
- package/dist/tools/generated/networking/index.js +0 -11289
- package/dist/tools/generated/networking/index.js.map +0 -1
- package/dist/tools/generated/nginx/index.d.ts +0 -8
- package/dist/tools/generated/nginx/index.d.ts.map +0 -1
- package/dist/tools/generated/nginx/index.js +0 -680
- package/dist/tools/generated/nginx/index.js.map +0 -1
- package/dist/tools/generated/operations/index.d.ts +0 -8
- package/dist/tools/generated/operations/index.d.ts.map +0 -1
- package/dist/tools/generated/operations/index.js +0 -1759
- package/dist/tools/generated/operations/index.js.map +0 -1
- package/dist/tools/generated/security/index.d.ts +0 -8
- package/dist/tools/generated/security/index.d.ts.map +0 -1
- package/dist/tools/generated/security/index.js +0 -9111
- package/dist/tools/generated/security/index.js.map +0 -1
- package/dist/tools/generated/shape_security/index.d.ts +0 -8
- package/dist/tools/generated/shape_security/index.d.ts.map +0 -1
- package/dist/tools/generated/shape_security/index.js +0 -4121
- package/dist/tools/generated/shape_security/index.js.map +0 -1
- package/dist/tools/generated/subscriptions/index.d.ts +0 -8
- package/dist/tools/generated/subscriptions/index.d.ts.map +0 -1
- package/dist/tools/generated/subscriptions/index.js +0 -778
- package/dist/tools/generated/subscriptions/index.js.map +0 -1
- package/dist/tools/generated/tenant_management/index.d.ts +0 -8
- package/dist/tools/generated/tenant_management/index.d.ts.map +0 -1
- package/dist/tools/generated/tenant_management/index.js +0 -2292
- package/dist/tools/generated/tenant_management/index.js.map +0 -1
- package/dist/tools/generated/vpn/index.d.ts +0 -8
- package/dist/tools/generated/vpn/index.js +0 -1183
- package/dist/tools/generated/vpn/index.js.map +0 -1
|
@@ -0,0 +1,3233 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated tool definitions for managed_kubernetes domain
|
|
3
|
+
* DO NOT EDIT - This file is auto-generated by scripts/generate.ts
|
|
4
|
+
*/
|
|
5
|
+
export const managed_kubernetesTools = [
|
|
6
|
+
{
|
|
7
|
+
toolName: "f5xc-api-managedkubernetes-container-registry-create",
|
|
8
|
+
method: "POST",
|
|
9
|
+
path: "/api/config/namespaces/{metadata.namespace}/container_registrys",
|
|
10
|
+
operation: "create",
|
|
11
|
+
domain: "managed_kubernetes",
|
|
12
|
+
resource: "container-registry",
|
|
13
|
+
summary: "Create Container Registry.",
|
|
14
|
+
description: "Shape of Container Registry.",
|
|
15
|
+
pathParameters: [
|
|
16
|
+
{
|
|
17
|
+
description: 'Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be ""',
|
|
18
|
+
in: "path",
|
|
19
|
+
name: "metadata.namespace",
|
|
20
|
+
required: true,
|
|
21
|
+
schema: {
|
|
22
|
+
type: "string",
|
|
23
|
+
},
|
|
24
|
+
"x-displayname": "Namespace",
|
|
25
|
+
"x-ves-example": "Staging",
|
|
26
|
+
},
|
|
27
|
+
],
|
|
28
|
+
queryParameters: [],
|
|
29
|
+
requestBodySchema: {
|
|
30
|
+
$ref: "#/components/schemas/container_registryCreateRequest",
|
|
31
|
+
},
|
|
32
|
+
responseSchema: {
|
|
33
|
+
$ref: "#/components/schemas/container_registryCreateResponse",
|
|
34
|
+
},
|
|
35
|
+
requiredParams: ["body", "metadata.namespace"],
|
|
36
|
+
operationId: "ves.io.schema.container_registry.API.Create",
|
|
37
|
+
tags: ["Other"],
|
|
38
|
+
sourceFile: "domains/managed_kubernetes.json",
|
|
39
|
+
displayName: null,
|
|
40
|
+
dangerLevel: "medium",
|
|
41
|
+
sideEffects: {
|
|
42
|
+
creates: ["container-registry"],
|
|
43
|
+
},
|
|
44
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
45
|
+
cliExamples: [
|
|
46
|
+
{
|
|
47
|
+
command: "f5xcctl config container-registry create {name} --namespace {namespace}",
|
|
48
|
+
description: "Create container-registry",
|
|
49
|
+
use_case: "basic_create",
|
|
50
|
+
},
|
|
51
|
+
{
|
|
52
|
+
command: "f5xcctl config container-registry create -f {file}.yaml",
|
|
53
|
+
description: "Create from YAML file",
|
|
54
|
+
use_case: "file_based",
|
|
55
|
+
},
|
|
56
|
+
],
|
|
57
|
+
confirmationRequired: false,
|
|
58
|
+
parameterExamples: {
|
|
59
|
+
"metadata.namespace": "Staging",
|
|
60
|
+
},
|
|
61
|
+
validationRules: {},
|
|
62
|
+
operationMetadata: {
|
|
63
|
+
common_errors: [
|
|
64
|
+
{
|
|
65
|
+
code: 401,
|
|
66
|
+
message: "Authentication required",
|
|
67
|
+
solution: "Provide valid API credentials",
|
|
68
|
+
},
|
|
69
|
+
{
|
|
70
|
+
code: 403,
|
|
71
|
+
message: "Permission denied",
|
|
72
|
+
solution: "Check access permissions for this operation",
|
|
73
|
+
},
|
|
74
|
+
{
|
|
75
|
+
code: 404,
|
|
76
|
+
message: "Resource not found",
|
|
77
|
+
solution: "Verify resource name, namespace, and path",
|
|
78
|
+
},
|
|
79
|
+
{
|
|
80
|
+
code: 409,
|
|
81
|
+
message: "Resource already exists",
|
|
82
|
+
solution: "Use different name or update existing resource",
|
|
83
|
+
},
|
|
84
|
+
{
|
|
85
|
+
code: 429,
|
|
86
|
+
message: "Rate limit exceeded",
|
|
87
|
+
solution: "Wait before retrying the operation",
|
|
88
|
+
},
|
|
89
|
+
{
|
|
90
|
+
code: 500,
|
|
91
|
+
message: "Server error",
|
|
92
|
+
solution: "Retry operation or contact support",
|
|
93
|
+
},
|
|
94
|
+
],
|
|
95
|
+
conditions: {
|
|
96
|
+
postconditions: [
|
|
97
|
+
"Container-registry resource created",
|
|
98
|
+
"Resource assigned unique identifier",
|
|
99
|
+
],
|
|
100
|
+
prerequisites: ["Active namespace"],
|
|
101
|
+
},
|
|
102
|
+
confirmation_required: false,
|
|
103
|
+
danger_level: "medium",
|
|
104
|
+
examples: [
|
|
105
|
+
{
|
|
106
|
+
command: "f5xcctl config container-registry create {name} --namespace {namespace}",
|
|
107
|
+
description: "Create container-registry",
|
|
108
|
+
use_case: "basic_create",
|
|
109
|
+
},
|
|
110
|
+
{
|
|
111
|
+
command: "f5xcctl config container-registry create -f {file}.yaml",
|
|
112
|
+
description: "Create from YAML file",
|
|
113
|
+
use_case: "file_based",
|
|
114
|
+
},
|
|
115
|
+
],
|
|
116
|
+
field_docs: {},
|
|
117
|
+
optional_fields: [],
|
|
118
|
+
performance_impact: {
|
|
119
|
+
latency: "low",
|
|
120
|
+
resource_usage: "low",
|
|
121
|
+
},
|
|
122
|
+
purpose: "Create new container-registry",
|
|
123
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
124
|
+
side_effects: {
|
|
125
|
+
creates: ["container-registry"],
|
|
126
|
+
},
|
|
127
|
+
},
|
|
128
|
+
},
|
|
129
|
+
{
|
|
130
|
+
toolName: "f5xc-api-managedkubernetes-container-registry-delete",
|
|
131
|
+
method: "DELETE",
|
|
132
|
+
path: "/api/config/namespaces/{namespace}/container_registrys/{name}",
|
|
133
|
+
operation: "delete",
|
|
134
|
+
domain: "managed_kubernetes",
|
|
135
|
+
resource: "container-registry",
|
|
136
|
+
summary: "DELETE Container Registry.",
|
|
137
|
+
description: "DELETE the specified container_registry.",
|
|
138
|
+
pathParameters: [
|
|
139
|
+
{
|
|
140
|
+
description: "Name\nName of the configuration object.",
|
|
141
|
+
in: "path",
|
|
142
|
+
name: "name",
|
|
143
|
+
required: true,
|
|
144
|
+
schema: {
|
|
145
|
+
type: "string",
|
|
146
|
+
},
|
|
147
|
+
"x-displayname": "Name",
|
|
148
|
+
"x-ves-example": "Name",
|
|
149
|
+
},
|
|
150
|
+
{
|
|
151
|
+
description: "Namespace\nNamespace in which the configuration object is present.",
|
|
152
|
+
in: "path",
|
|
153
|
+
name: "namespace",
|
|
154
|
+
required: true,
|
|
155
|
+
schema: {
|
|
156
|
+
type: "string",
|
|
157
|
+
},
|
|
158
|
+
"x-displayname": "Namespace",
|
|
159
|
+
"x-ves-example": "Ns1",
|
|
160
|
+
},
|
|
161
|
+
],
|
|
162
|
+
queryParameters: [],
|
|
163
|
+
requestBodySchema: {
|
|
164
|
+
$ref: "#/components/schemas/container_registryDeleteRequest",
|
|
165
|
+
},
|
|
166
|
+
responseSchema: {},
|
|
167
|
+
requiredParams: ["body", "name", "namespace"],
|
|
168
|
+
operationId: "ves.io.schema.container_registry.API.Delete",
|
|
169
|
+
tags: ["Other"],
|
|
170
|
+
sourceFile: "domains/managed_kubernetes.json",
|
|
171
|
+
displayName: null,
|
|
172
|
+
dangerLevel: "high",
|
|
173
|
+
sideEffects: {
|
|
174
|
+
deletes: ["container-registry", "contained_resources"],
|
|
175
|
+
},
|
|
176
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
177
|
+
cliExamples: [
|
|
178
|
+
{
|
|
179
|
+
command: "f5xcctl config container-registry delete {name} --namespace {namespace}",
|
|
180
|
+
description: "Delete container-registry",
|
|
181
|
+
use_case: "delete",
|
|
182
|
+
},
|
|
183
|
+
],
|
|
184
|
+
confirmationRequired: true,
|
|
185
|
+
parameterExamples: {
|
|
186
|
+
name: "Name",
|
|
187
|
+
namespace: "Ns1",
|
|
188
|
+
},
|
|
189
|
+
validationRules: {},
|
|
190
|
+
operationMetadata: {
|
|
191
|
+
common_errors: [
|
|
192
|
+
{
|
|
193
|
+
code: 401,
|
|
194
|
+
message: "Authentication required",
|
|
195
|
+
solution: "Provide valid API credentials",
|
|
196
|
+
},
|
|
197
|
+
{
|
|
198
|
+
code: 403,
|
|
199
|
+
message: "Permission denied",
|
|
200
|
+
solution: "Check access permissions for this operation",
|
|
201
|
+
},
|
|
202
|
+
{
|
|
203
|
+
code: 404,
|
|
204
|
+
message: "Resource not found",
|
|
205
|
+
solution: "Verify resource name, namespace, and path",
|
|
206
|
+
},
|
|
207
|
+
{
|
|
208
|
+
code: 409,
|
|
209
|
+
message: "Resource already exists",
|
|
210
|
+
solution: "Use different name or update existing resource",
|
|
211
|
+
},
|
|
212
|
+
{
|
|
213
|
+
code: 429,
|
|
214
|
+
message: "Rate limit exceeded",
|
|
215
|
+
solution: "Wait before retrying the operation",
|
|
216
|
+
},
|
|
217
|
+
{
|
|
218
|
+
code: 500,
|
|
219
|
+
message: "Server error",
|
|
220
|
+
solution: "Retry operation or contact support",
|
|
221
|
+
},
|
|
222
|
+
],
|
|
223
|
+
conditions: {
|
|
224
|
+
postconditions: ["Resource removed from system", "Associated resources may be affected"],
|
|
225
|
+
prerequisites: ["Active namespace"],
|
|
226
|
+
},
|
|
227
|
+
confirmation_required: true,
|
|
228
|
+
danger_level: "high",
|
|
229
|
+
examples: [
|
|
230
|
+
{
|
|
231
|
+
command: "f5xcctl config container-registry delete {name} --namespace {namespace}",
|
|
232
|
+
description: "Delete container-registry",
|
|
233
|
+
use_case: "delete",
|
|
234
|
+
},
|
|
235
|
+
],
|
|
236
|
+
field_docs: {},
|
|
237
|
+
optional_fields: [],
|
|
238
|
+
performance_impact: {
|
|
239
|
+
latency: "high",
|
|
240
|
+
resource_usage: "moderate",
|
|
241
|
+
},
|
|
242
|
+
purpose: "Delete container-registry",
|
|
243
|
+
required_fields: ["path.name", "path.namespace"],
|
|
244
|
+
side_effects: {
|
|
245
|
+
deletes: ["container-registry", "contained_resources"],
|
|
246
|
+
},
|
|
247
|
+
},
|
|
248
|
+
},
|
|
249
|
+
{
|
|
250
|
+
toolName: "f5xc-api-managedkubernetes-container-registry-get",
|
|
251
|
+
method: "GET",
|
|
252
|
+
path: "/api/config/namespaces/{namespace}/container_registrys/{name}",
|
|
253
|
+
operation: "get",
|
|
254
|
+
domain: "managed_kubernetes",
|
|
255
|
+
resource: "container-registry",
|
|
256
|
+
summary: "GET Container Registry.",
|
|
257
|
+
description: "Shape of Container Registry.",
|
|
258
|
+
pathParameters: [
|
|
259
|
+
{
|
|
260
|
+
description: "Name\nThe name of the configuration object to be fetched.",
|
|
261
|
+
in: "path",
|
|
262
|
+
name: "name",
|
|
263
|
+
required: true,
|
|
264
|
+
schema: {
|
|
265
|
+
type: "string",
|
|
266
|
+
},
|
|
267
|
+
"x-displayname": "Name",
|
|
268
|
+
"x-ves-example": "Name",
|
|
269
|
+
},
|
|
270
|
+
{
|
|
271
|
+
description: "Namespace\nThe namespace in which the configuration object is present.",
|
|
272
|
+
in: "path",
|
|
273
|
+
name: "namespace",
|
|
274
|
+
required: true,
|
|
275
|
+
schema: {
|
|
276
|
+
type: "string",
|
|
277
|
+
},
|
|
278
|
+
"x-displayname": "Namespace",
|
|
279
|
+
"x-ves-example": "Ns1",
|
|
280
|
+
},
|
|
281
|
+
],
|
|
282
|
+
queryParameters: [
|
|
283
|
+
{
|
|
284
|
+
description: "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referrred by this object.",
|
|
285
|
+
in: "query",
|
|
286
|
+
name: "response_format",
|
|
287
|
+
required: false,
|
|
288
|
+
schema: {
|
|
289
|
+
default: "GET_RSP_FORMAT_DEFAULT",
|
|
290
|
+
enum: [
|
|
291
|
+
"GET_RSP_FORMAT_DEFAULT",
|
|
292
|
+
"GET_RSP_FORMAT_FOR_CREATE",
|
|
293
|
+
"GET_RSP_FORMAT_FOR_REPLACE",
|
|
294
|
+
"GET_RSP_FORMAT_STATUS",
|
|
295
|
+
"GET_RSP_FORMAT_READ",
|
|
296
|
+
"GET_RSP_FORMAT_REFERRING_OBJECTS",
|
|
297
|
+
"GET_RSP_FORMAT_BROKEN_REFERENCES",
|
|
298
|
+
],
|
|
299
|
+
type: "string",
|
|
300
|
+
},
|
|
301
|
+
"x-displayname": "Broken Referred Objects.",
|
|
302
|
+
},
|
|
303
|
+
],
|
|
304
|
+
requestBodySchema: null,
|
|
305
|
+
responseSchema: {
|
|
306
|
+
$ref: "#/components/schemas/container_registryGetResponse",
|
|
307
|
+
},
|
|
308
|
+
requiredParams: ["name", "namespace"],
|
|
309
|
+
operationId: "ves.io.schema.container_registry.API.Get",
|
|
310
|
+
tags: ["Other"],
|
|
311
|
+
sourceFile: "domains/managed_kubernetes.json",
|
|
312
|
+
displayName: null,
|
|
313
|
+
dangerLevel: "low",
|
|
314
|
+
sideEffects: null,
|
|
315
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
316
|
+
cliExamples: [
|
|
317
|
+
{
|
|
318
|
+
command: "f5xcctl config container-registry get {name} --namespace {namespace}",
|
|
319
|
+
description: "Get specific container-registry",
|
|
320
|
+
use_case: "get_specific",
|
|
321
|
+
},
|
|
322
|
+
],
|
|
323
|
+
confirmationRequired: false,
|
|
324
|
+
parameterExamples: {
|
|
325
|
+
name: "Name",
|
|
326
|
+
namespace: "Ns1",
|
|
327
|
+
},
|
|
328
|
+
validationRules: {},
|
|
329
|
+
operationMetadata: {
|
|
330
|
+
common_errors: [
|
|
331
|
+
{
|
|
332
|
+
code: 401,
|
|
333
|
+
message: "Authentication required",
|
|
334
|
+
solution: "Provide valid API credentials",
|
|
335
|
+
},
|
|
336
|
+
{
|
|
337
|
+
code: 403,
|
|
338
|
+
message: "Permission denied",
|
|
339
|
+
solution: "Check access permissions for this operation",
|
|
340
|
+
},
|
|
341
|
+
{
|
|
342
|
+
code: 404,
|
|
343
|
+
message: "Resource not found",
|
|
344
|
+
solution: "Verify resource name, namespace, and path",
|
|
345
|
+
},
|
|
346
|
+
{
|
|
347
|
+
code: 409,
|
|
348
|
+
message: "Resource already exists",
|
|
349
|
+
solution: "Use different name or update existing resource",
|
|
350
|
+
},
|
|
351
|
+
{
|
|
352
|
+
code: 429,
|
|
353
|
+
message: "Rate limit exceeded",
|
|
354
|
+
solution: "Wait before retrying the operation",
|
|
355
|
+
},
|
|
356
|
+
{
|
|
357
|
+
code: 500,
|
|
358
|
+
message: "Server error",
|
|
359
|
+
solution: "Retry operation or contact support",
|
|
360
|
+
},
|
|
361
|
+
],
|
|
362
|
+
conditions: {
|
|
363
|
+
postconditions: [],
|
|
364
|
+
prerequisites: ["Active namespace"],
|
|
365
|
+
},
|
|
366
|
+
confirmation_required: false,
|
|
367
|
+
danger_level: "low",
|
|
368
|
+
examples: [
|
|
369
|
+
{
|
|
370
|
+
command: "f5xcctl config container-registry get {name} --namespace {namespace}",
|
|
371
|
+
description: "Get specific container-registry",
|
|
372
|
+
use_case: "get_specific",
|
|
373
|
+
},
|
|
374
|
+
],
|
|
375
|
+
field_docs: {},
|
|
376
|
+
optional_fields: [],
|
|
377
|
+
performance_impact: {
|
|
378
|
+
latency: "low",
|
|
379
|
+
resource_usage: "low",
|
|
380
|
+
},
|
|
381
|
+
purpose: "Retrieve specific container-registry",
|
|
382
|
+
required_fields: ["path.name", "path.namespace"],
|
|
383
|
+
side_effects: {},
|
|
384
|
+
},
|
|
385
|
+
},
|
|
386
|
+
{
|
|
387
|
+
toolName: "f5xc-api-managedkubernetes-container-registry-list",
|
|
388
|
+
method: "GET",
|
|
389
|
+
path: "/api/config/namespaces/{namespace}/container_registrys",
|
|
390
|
+
operation: "list",
|
|
391
|
+
domain: "managed_kubernetes",
|
|
392
|
+
resource: "container-registry",
|
|
393
|
+
summary: "List Container Registry.",
|
|
394
|
+
description: "List the set of container_registry in a namespace.",
|
|
395
|
+
pathParameters: [
|
|
396
|
+
{
|
|
397
|
+
description: "Namespace\nNamespace to scope the listing of container_registry.",
|
|
398
|
+
in: "path",
|
|
399
|
+
name: "namespace",
|
|
400
|
+
required: true,
|
|
401
|
+
schema: {
|
|
402
|
+
type: "string",
|
|
403
|
+
},
|
|
404
|
+
"x-displayname": "Namespace",
|
|
405
|
+
"x-ves-example": "Ns1",
|
|
406
|
+
},
|
|
407
|
+
],
|
|
408
|
+
queryParameters: [
|
|
409
|
+
{
|
|
410
|
+
description: "A LabelSelectorType expression that every item in list response will satisfy.",
|
|
411
|
+
in: "query",
|
|
412
|
+
name: "label_filter",
|
|
413
|
+
required: false,
|
|
414
|
+
schema: {
|
|
415
|
+
type: "string",
|
|
416
|
+
},
|
|
417
|
+
"x-displayname": "Label Filter.",
|
|
418
|
+
"x-ves-example": "Env in (staging, testing), tier in (web, db)",
|
|
419
|
+
},
|
|
420
|
+
{
|
|
421
|
+
description: 'X-example: ""\nExtra fields to return along with summary fields.',
|
|
422
|
+
in: "query",
|
|
423
|
+
name: "report_fields",
|
|
424
|
+
required: false,
|
|
425
|
+
schema: {
|
|
426
|
+
items: {
|
|
427
|
+
type: "string",
|
|
428
|
+
},
|
|
429
|
+
type: "array",
|
|
430
|
+
},
|
|
431
|
+
"x-displayname": "Report Fields.",
|
|
432
|
+
},
|
|
433
|
+
{
|
|
434
|
+
description: 'X-example: ""\nExtra status fields to return along with summary fields.',
|
|
435
|
+
in: "query",
|
|
436
|
+
name: "report_status_fields",
|
|
437
|
+
required: false,
|
|
438
|
+
schema: {
|
|
439
|
+
items: {
|
|
440
|
+
type: "string",
|
|
441
|
+
},
|
|
442
|
+
type: "array",
|
|
443
|
+
},
|
|
444
|
+
"x-displayname": "Report Status Fields.",
|
|
445
|
+
},
|
|
446
|
+
],
|
|
447
|
+
requestBodySchema: null,
|
|
448
|
+
responseSchema: {
|
|
449
|
+
$ref: "#/components/schemas/container_registryListResponse",
|
|
450
|
+
},
|
|
451
|
+
requiredParams: ["namespace"],
|
|
452
|
+
operationId: "ves.io.schema.container_registry.API.List",
|
|
453
|
+
tags: ["Other"],
|
|
454
|
+
sourceFile: "domains/managed_kubernetes.json",
|
|
455
|
+
displayName: null,
|
|
456
|
+
dangerLevel: "low",
|
|
457
|
+
sideEffects: null,
|
|
458
|
+
requiredFields: ["path.namespace"],
|
|
459
|
+
cliExamples: [
|
|
460
|
+
{
|
|
461
|
+
command: "f5xcctl config container-registry list --namespace {namespace}",
|
|
462
|
+
description: "List all container-registrys",
|
|
463
|
+
use_case: "list_all",
|
|
464
|
+
},
|
|
465
|
+
],
|
|
466
|
+
confirmationRequired: false,
|
|
467
|
+
parameterExamples: {
|
|
468
|
+
label_filter: "Env in (staging, testing), tier in (web, db)",
|
|
469
|
+
namespace: "Ns1",
|
|
470
|
+
},
|
|
471
|
+
validationRules: {},
|
|
472
|
+
operationMetadata: {
|
|
473
|
+
common_errors: [
|
|
474
|
+
{
|
|
475
|
+
code: 401,
|
|
476
|
+
message: "Authentication required",
|
|
477
|
+
solution: "Provide valid API credentials",
|
|
478
|
+
},
|
|
479
|
+
{
|
|
480
|
+
code: 403,
|
|
481
|
+
message: "Permission denied",
|
|
482
|
+
solution: "Check access permissions for this operation",
|
|
483
|
+
},
|
|
484
|
+
{
|
|
485
|
+
code: 404,
|
|
486
|
+
message: "Resource not found",
|
|
487
|
+
solution: "Verify resource name, namespace, and path",
|
|
488
|
+
},
|
|
489
|
+
{
|
|
490
|
+
code: 409,
|
|
491
|
+
message: "Resource already exists",
|
|
492
|
+
solution: "Use different name or update existing resource",
|
|
493
|
+
},
|
|
494
|
+
{
|
|
495
|
+
code: 429,
|
|
496
|
+
message: "Rate limit exceeded",
|
|
497
|
+
solution: "Wait before retrying the operation",
|
|
498
|
+
},
|
|
499
|
+
{
|
|
500
|
+
code: 500,
|
|
501
|
+
message: "Server error",
|
|
502
|
+
solution: "Retry operation or contact support",
|
|
503
|
+
},
|
|
504
|
+
],
|
|
505
|
+
conditions: {
|
|
506
|
+
postconditions: [],
|
|
507
|
+
prerequisites: ["Active namespace"],
|
|
508
|
+
},
|
|
509
|
+
confirmation_required: false,
|
|
510
|
+
danger_level: "low",
|
|
511
|
+
examples: [
|
|
512
|
+
{
|
|
513
|
+
command: "f5xcctl config container-registry list --namespace {namespace}",
|
|
514
|
+
description: "List all container-registrys",
|
|
515
|
+
use_case: "list_all",
|
|
516
|
+
},
|
|
517
|
+
],
|
|
518
|
+
field_docs: {},
|
|
519
|
+
optional_fields: [],
|
|
520
|
+
performance_impact: {
|
|
521
|
+
latency: "moderate",
|
|
522
|
+
resource_usage: "moderate",
|
|
523
|
+
},
|
|
524
|
+
purpose: "List all container-registrys",
|
|
525
|
+
required_fields: ["path.namespace"],
|
|
526
|
+
side_effects: {},
|
|
527
|
+
},
|
|
528
|
+
},
|
|
529
|
+
{
|
|
530
|
+
toolName: "f5xc-api-managedkubernetes-container-registry-update",
|
|
531
|
+
method: "PUT",
|
|
532
|
+
path: "/api/config/namespaces/{metadata.namespace}/container_registrys/{metadata.name}",
|
|
533
|
+
operation: "update",
|
|
534
|
+
domain: "managed_kubernetes",
|
|
535
|
+
resource: "container-registry",
|
|
536
|
+
summary: "Replace Container Registry.",
|
|
537
|
+
description: "Shape of Container Registry.",
|
|
538
|
+
pathParameters: [
|
|
539
|
+
{
|
|
540
|
+
description: "Name\nThe configuration object to be replaced will be looked up by name.",
|
|
541
|
+
in: "path",
|
|
542
|
+
name: "metadata.name",
|
|
543
|
+
required: true,
|
|
544
|
+
schema: {
|
|
545
|
+
type: "string",
|
|
546
|
+
},
|
|
547
|
+
"x-displayname": "Name",
|
|
548
|
+
"x-ves-example": "Example-corp-web.",
|
|
549
|
+
},
|
|
550
|
+
{
|
|
551
|
+
description: 'Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be ""',
|
|
552
|
+
in: "path",
|
|
553
|
+
name: "metadata.namespace",
|
|
554
|
+
required: true,
|
|
555
|
+
schema: {
|
|
556
|
+
type: "string",
|
|
557
|
+
},
|
|
558
|
+
"x-displayname": "Namespace",
|
|
559
|
+
"x-ves-example": "Staging",
|
|
560
|
+
},
|
|
561
|
+
],
|
|
562
|
+
queryParameters: [],
|
|
563
|
+
requestBodySchema: {
|
|
564
|
+
$ref: "#/components/schemas/container_registryReplaceRequest",
|
|
565
|
+
},
|
|
566
|
+
responseSchema: {
|
|
567
|
+
$ref: "#/components/schemas/container_registryReplaceResponse",
|
|
568
|
+
},
|
|
569
|
+
requiredParams: ["body", "metadata.name", "metadata.namespace"],
|
|
570
|
+
operationId: "ves.io.schema.container_registry.API.Replace",
|
|
571
|
+
tags: ["Other"],
|
|
572
|
+
sourceFile: "domains/managed_kubernetes.json",
|
|
573
|
+
displayName: null,
|
|
574
|
+
dangerLevel: "medium",
|
|
575
|
+
sideEffects: {
|
|
576
|
+
modifies: ["container-registry"],
|
|
577
|
+
},
|
|
578
|
+
requiredFields: ["path.metadata.name", "path.metadata.namespace"],
|
|
579
|
+
cliExamples: [
|
|
580
|
+
{
|
|
581
|
+
command: "f5xcctl config container-registry update {name} --namespace {namespace} -f {file}.yaml",
|
|
582
|
+
description: "Update container-registry",
|
|
583
|
+
use_case: "update",
|
|
584
|
+
},
|
|
585
|
+
],
|
|
586
|
+
confirmationRequired: false,
|
|
587
|
+
parameterExamples: {
|
|
588
|
+
"metadata.name": "Example-corp-web.",
|
|
589
|
+
"metadata.namespace": "Staging",
|
|
590
|
+
},
|
|
591
|
+
validationRules: {},
|
|
592
|
+
operationMetadata: {
|
|
593
|
+
common_errors: [
|
|
594
|
+
{
|
|
595
|
+
code: 401,
|
|
596
|
+
message: "Authentication required",
|
|
597
|
+
solution: "Provide valid API credentials",
|
|
598
|
+
},
|
|
599
|
+
{
|
|
600
|
+
code: 403,
|
|
601
|
+
message: "Permission denied",
|
|
602
|
+
solution: "Check access permissions for this operation",
|
|
603
|
+
},
|
|
604
|
+
{
|
|
605
|
+
code: 404,
|
|
606
|
+
message: "Resource not found",
|
|
607
|
+
solution: "Verify resource name, namespace, and path",
|
|
608
|
+
},
|
|
609
|
+
{
|
|
610
|
+
code: 409,
|
|
611
|
+
message: "Resource already exists",
|
|
612
|
+
solution: "Use different name or update existing resource",
|
|
613
|
+
},
|
|
614
|
+
{
|
|
615
|
+
code: 429,
|
|
616
|
+
message: "Rate limit exceeded",
|
|
617
|
+
solution: "Wait before retrying the operation",
|
|
618
|
+
},
|
|
619
|
+
{
|
|
620
|
+
code: 500,
|
|
621
|
+
message: "Server error",
|
|
622
|
+
solution: "Retry operation or contact support",
|
|
623
|
+
},
|
|
624
|
+
],
|
|
625
|
+
conditions: {
|
|
626
|
+
postconditions: ["Resource updated with new values"],
|
|
627
|
+
prerequisites: ["Active namespace"],
|
|
628
|
+
},
|
|
629
|
+
confirmation_required: false,
|
|
630
|
+
danger_level: "medium",
|
|
631
|
+
examples: [
|
|
632
|
+
{
|
|
633
|
+
command: "f5xcctl config container-registry update {name} --namespace {namespace} -f {file}.yaml",
|
|
634
|
+
description: "Update container-registry",
|
|
635
|
+
use_case: "update",
|
|
636
|
+
},
|
|
637
|
+
],
|
|
638
|
+
field_docs: {},
|
|
639
|
+
optional_fields: [],
|
|
640
|
+
performance_impact: {
|
|
641
|
+
latency: "low",
|
|
642
|
+
resource_usage: "low",
|
|
643
|
+
},
|
|
644
|
+
purpose: "Replace existing container-registry",
|
|
645
|
+
required_fields: ["path.metadata.name", "path.metadata.namespace"],
|
|
646
|
+
side_effects: {
|
|
647
|
+
modifies: ["container-registry"],
|
|
648
|
+
},
|
|
649
|
+
},
|
|
650
|
+
},
|
|
651
|
+
{
|
|
652
|
+
toolName: "f5xc-api-managedkubernetes-k8s-cluster-role-binding-create",
|
|
653
|
+
method: "POST",
|
|
654
|
+
path: "/api/config/namespaces/{metadata.namespace}/k8s_cluster_role_bindings",
|
|
655
|
+
operation: "create",
|
|
656
|
+
domain: "managed_kubernetes",
|
|
657
|
+
resource: "k8s-cluster-role-binding",
|
|
658
|
+
summary: "Create Configuration Specification.",
|
|
659
|
+
description: "Create k8s_cluster_role_binding will create the object in the storage backend for namespace metadata.namespace.",
|
|
660
|
+
pathParameters: [
|
|
661
|
+
{
|
|
662
|
+
description: 'Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be ""',
|
|
663
|
+
in: "path",
|
|
664
|
+
name: "metadata.namespace",
|
|
665
|
+
required: true,
|
|
666
|
+
schema: {
|
|
667
|
+
type: "string",
|
|
668
|
+
},
|
|
669
|
+
"x-displayname": "Namespace",
|
|
670
|
+
"x-ves-example": "Staging",
|
|
671
|
+
},
|
|
672
|
+
],
|
|
673
|
+
queryParameters: [],
|
|
674
|
+
requestBodySchema: {
|
|
675
|
+
$ref: "#/components/schemas/k8s_cluster_role_bindingCreateRequest",
|
|
676
|
+
},
|
|
677
|
+
responseSchema: {
|
|
678
|
+
$ref: "#/components/schemas/k8s_cluster_role_bindingCreateResponse",
|
|
679
|
+
},
|
|
680
|
+
requiredParams: ["body", "metadata.namespace"],
|
|
681
|
+
operationId: "ves.io.schema.k8s_cluster_role_binding.API.Create",
|
|
682
|
+
tags: ["Other"],
|
|
683
|
+
sourceFile: "domains/managed_kubernetes.json",
|
|
684
|
+
displayName: null,
|
|
685
|
+
dangerLevel: "medium",
|
|
686
|
+
sideEffects: {
|
|
687
|
+
creates: ["k8s-cluster-role-binding"],
|
|
688
|
+
},
|
|
689
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
690
|
+
cliExamples: [
|
|
691
|
+
{
|
|
692
|
+
command: "f5xcctl config k8s-cluster-role-binding create -f {file}.yaml",
|
|
693
|
+
description: "Create from YAML file",
|
|
694
|
+
use_case: "file_based",
|
|
695
|
+
},
|
|
696
|
+
{
|
|
697
|
+
command: "f5xcctl config k8s-cluster-role-binding create {name} --namespace {namespace}",
|
|
698
|
+
description: "Create k8s-cluster-role-binding",
|
|
699
|
+
use_case: "basic_create",
|
|
700
|
+
},
|
|
701
|
+
],
|
|
702
|
+
confirmationRequired: false,
|
|
703
|
+
parameterExamples: {
|
|
704
|
+
"metadata.namespace": "Staging",
|
|
705
|
+
},
|
|
706
|
+
validationRules: {},
|
|
707
|
+
operationMetadata: {
|
|
708
|
+
common_errors: [
|
|
709
|
+
{
|
|
710
|
+
code: 401,
|
|
711
|
+
message: "Authentication required",
|
|
712
|
+
solution: "Provide valid API credentials",
|
|
713
|
+
},
|
|
714
|
+
{
|
|
715
|
+
code: 403,
|
|
716
|
+
message: "Permission denied",
|
|
717
|
+
solution: "Check access permissions for this operation",
|
|
718
|
+
},
|
|
719
|
+
{
|
|
720
|
+
code: 404,
|
|
721
|
+
message: "Resource not found",
|
|
722
|
+
solution: "Verify resource name, namespace, and path",
|
|
723
|
+
},
|
|
724
|
+
{
|
|
725
|
+
code: 409,
|
|
726
|
+
message: "Resource already exists",
|
|
727
|
+
solution: "Use different name or update existing resource",
|
|
728
|
+
},
|
|
729
|
+
{
|
|
730
|
+
code: 429,
|
|
731
|
+
message: "Rate limit exceeded",
|
|
732
|
+
solution: "Wait before retrying the operation",
|
|
733
|
+
},
|
|
734
|
+
{
|
|
735
|
+
code: 500,
|
|
736
|
+
message: "Server error",
|
|
737
|
+
solution: "Retry operation or contact support",
|
|
738
|
+
},
|
|
739
|
+
],
|
|
740
|
+
conditions: {
|
|
741
|
+
postconditions: [
|
|
742
|
+
"K8s-cluster-role-binding resource created",
|
|
743
|
+
"Resource assigned unique identifier",
|
|
744
|
+
],
|
|
745
|
+
prerequisites: ["Active namespace"],
|
|
746
|
+
},
|
|
747
|
+
confirmation_required: false,
|
|
748
|
+
danger_level: "medium",
|
|
749
|
+
examples: [
|
|
750
|
+
{
|
|
751
|
+
command: "f5xcctl config k8s-cluster-role-binding create {name} --namespace {namespace}",
|
|
752
|
+
description: "Create k8s-cluster-role-binding",
|
|
753
|
+
use_case: "basic_create",
|
|
754
|
+
},
|
|
755
|
+
{
|
|
756
|
+
command: "f5xcctl config k8s-cluster-role-binding create -f {file}.yaml",
|
|
757
|
+
description: "Create from YAML file",
|
|
758
|
+
use_case: "file_based",
|
|
759
|
+
},
|
|
760
|
+
],
|
|
761
|
+
field_docs: {},
|
|
762
|
+
optional_fields: [],
|
|
763
|
+
performance_impact: {
|
|
764
|
+
latency: "low",
|
|
765
|
+
resource_usage: "low",
|
|
766
|
+
},
|
|
767
|
+
purpose: "Create new k8s-cluster-role-binding",
|
|
768
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
769
|
+
side_effects: {
|
|
770
|
+
creates: ["k8s-cluster-role-binding"],
|
|
771
|
+
},
|
|
772
|
+
},
|
|
773
|
+
},
|
|
774
|
+
{
|
|
775
|
+
toolName: "f5xc-api-managedkubernetes-k8s-cluster-role-binding-delete",
|
|
776
|
+
method: "DELETE",
|
|
777
|
+
path: "/api/config/namespaces/{namespace}/k8s_cluster_role_bindings/{name}",
|
|
778
|
+
operation: "delete",
|
|
779
|
+
domain: "managed_kubernetes",
|
|
780
|
+
resource: "k8s-cluster-role-binding",
|
|
781
|
+
summary: "DELETE K8s Cluster Role Binding.",
|
|
782
|
+
description: "DELETE the specified k8s_cluster_role_binding.",
|
|
783
|
+
pathParameters: [
|
|
784
|
+
{
|
|
785
|
+
description: "Name\nName of the configuration object.",
|
|
786
|
+
in: "path",
|
|
787
|
+
name: "name",
|
|
788
|
+
required: true,
|
|
789
|
+
schema: {
|
|
790
|
+
type: "string",
|
|
791
|
+
},
|
|
792
|
+
"x-displayname": "Name",
|
|
793
|
+
"x-ves-example": "Name",
|
|
794
|
+
},
|
|
795
|
+
{
|
|
796
|
+
description: "Namespace\nNamespace in which the configuration object is present.",
|
|
797
|
+
in: "path",
|
|
798
|
+
name: "namespace",
|
|
799
|
+
required: true,
|
|
800
|
+
schema: {
|
|
801
|
+
type: "string",
|
|
802
|
+
},
|
|
803
|
+
"x-displayname": "Namespace",
|
|
804
|
+
"x-ves-example": "Ns1",
|
|
805
|
+
},
|
|
806
|
+
],
|
|
807
|
+
queryParameters: [],
|
|
808
|
+
requestBodySchema: {
|
|
809
|
+
$ref: "#/components/schemas/k8s_cluster_role_bindingDeleteRequest",
|
|
810
|
+
},
|
|
811
|
+
responseSchema: {},
|
|
812
|
+
requiredParams: ["body", "name", "namespace"],
|
|
813
|
+
operationId: "ves.io.schema.k8s_cluster_role_binding.API.Delete",
|
|
814
|
+
tags: ["Other"],
|
|
815
|
+
sourceFile: "domains/managed_kubernetes.json",
|
|
816
|
+
displayName: null,
|
|
817
|
+
dangerLevel: "high",
|
|
818
|
+
sideEffects: {
|
|
819
|
+
deletes: ["k8s-cluster-role-binding", "contained_resources"],
|
|
820
|
+
},
|
|
821
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
822
|
+
cliExamples: [
|
|
823
|
+
{
|
|
824
|
+
command: "f5xcctl config k8s-cluster-role-binding delete {name} --namespace {namespace}",
|
|
825
|
+
description: "Delete k8s-cluster-role-binding",
|
|
826
|
+
use_case: "delete",
|
|
827
|
+
},
|
|
828
|
+
],
|
|
829
|
+
confirmationRequired: true,
|
|
830
|
+
parameterExamples: {
|
|
831
|
+
name: "Name",
|
|
832
|
+
namespace: "Ns1",
|
|
833
|
+
},
|
|
834
|
+
validationRules: {},
|
|
835
|
+
operationMetadata: {
|
|
836
|
+
common_errors: [
|
|
837
|
+
{
|
|
838
|
+
code: 401,
|
|
839
|
+
message: "Authentication required",
|
|
840
|
+
solution: "Provide valid API credentials",
|
|
841
|
+
},
|
|
842
|
+
{
|
|
843
|
+
code: 403,
|
|
844
|
+
message: "Permission denied",
|
|
845
|
+
solution: "Check access permissions for this operation",
|
|
846
|
+
},
|
|
847
|
+
{
|
|
848
|
+
code: 404,
|
|
849
|
+
message: "Resource not found",
|
|
850
|
+
solution: "Verify resource name, namespace, and path",
|
|
851
|
+
},
|
|
852
|
+
{
|
|
853
|
+
code: 409,
|
|
854
|
+
message: "Resource already exists",
|
|
855
|
+
solution: "Use different name or update existing resource",
|
|
856
|
+
},
|
|
857
|
+
{
|
|
858
|
+
code: 429,
|
|
859
|
+
message: "Rate limit exceeded",
|
|
860
|
+
solution: "Wait before retrying the operation",
|
|
861
|
+
},
|
|
862
|
+
{
|
|
863
|
+
code: 500,
|
|
864
|
+
message: "Server error",
|
|
865
|
+
solution: "Retry operation or contact support",
|
|
866
|
+
},
|
|
867
|
+
],
|
|
868
|
+
conditions: {
|
|
869
|
+
postconditions: ["Resource removed from system", "Associated resources may be affected"],
|
|
870
|
+
prerequisites: ["Active namespace"],
|
|
871
|
+
},
|
|
872
|
+
confirmation_required: true,
|
|
873
|
+
danger_level: "high",
|
|
874
|
+
examples: [
|
|
875
|
+
{
|
|
876
|
+
command: "f5xcctl config k8s-cluster-role-binding delete {name} --namespace {namespace}",
|
|
877
|
+
description: "Delete k8s-cluster-role-binding",
|
|
878
|
+
use_case: "delete",
|
|
879
|
+
},
|
|
880
|
+
],
|
|
881
|
+
field_docs: {},
|
|
882
|
+
optional_fields: [],
|
|
883
|
+
performance_impact: {
|
|
884
|
+
latency: "high",
|
|
885
|
+
resource_usage: "moderate",
|
|
886
|
+
},
|
|
887
|
+
purpose: "Delete k8s-cluster-role-binding",
|
|
888
|
+
required_fields: ["path.name", "path.namespace"],
|
|
889
|
+
side_effects: {
|
|
890
|
+
deletes: ["k8s-cluster-role-binding", "contained_resources"],
|
|
891
|
+
},
|
|
892
|
+
},
|
|
893
|
+
},
|
|
894
|
+
{
|
|
895
|
+
toolName: "f5xc-api-managedkubernetes-k8s-cluster-role-binding-get",
|
|
896
|
+
method: "GET",
|
|
897
|
+
path: "/api/config/namespaces/{namespace}/k8s_cluster_role_bindings/{name}",
|
|
898
|
+
operation: "get",
|
|
899
|
+
domain: "managed_kubernetes",
|
|
900
|
+
resource: "k8s-cluster-role-binding",
|
|
901
|
+
summary: "GET Configuration Specification.",
|
|
902
|
+
description: "GET k8s_cluster_role_binding will GET the object from the storage backend for namespace metadata.namespace.",
|
|
903
|
+
pathParameters: [
|
|
904
|
+
{
|
|
905
|
+
description: "Name\nThe name of the configuration object to be fetched.",
|
|
906
|
+
in: "path",
|
|
907
|
+
name: "name",
|
|
908
|
+
required: true,
|
|
909
|
+
schema: {
|
|
910
|
+
type: "string",
|
|
911
|
+
},
|
|
912
|
+
"x-displayname": "Name",
|
|
913
|
+
"x-ves-example": "Name",
|
|
914
|
+
},
|
|
915
|
+
{
|
|
916
|
+
description: "Namespace\nThe namespace in which the configuration object is present.",
|
|
917
|
+
in: "path",
|
|
918
|
+
name: "namespace",
|
|
919
|
+
required: true,
|
|
920
|
+
schema: {
|
|
921
|
+
type: "string",
|
|
922
|
+
},
|
|
923
|
+
"x-displayname": "Namespace",
|
|
924
|
+
"x-ves-example": "Ns1",
|
|
925
|
+
},
|
|
926
|
+
],
|
|
927
|
+
queryParameters: [
|
|
928
|
+
{
|
|
929
|
+
description: "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referrred by this object.",
|
|
930
|
+
in: "query",
|
|
931
|
+
name: "response_format",
|
|
932
|
+
required: false,
|
|
933
|
+
schema: {
|
|
934
|
+
default: "GET_RSP_FORMAT_DEFAULT",
|
|
935
|
+
enum: [
|
|
936
|
+
"GET_RSP_FORMAT_DEFAULT",
|
|
937
|
+
"GET_RSP_FORMAT_FOR_CREATE",
|
|
938
|
+
"GET_RSP_FORMAT_FOR_REPLACE",
|
|
939
|
+
"GET_RSP_FORMAT_STATUS",
|
|
940
|
+
"GET_RSP_FORMAT_READ",
|
|
941
|
+
"GET_RSP_FORMAT_REFERRING_OBJECTS",
|
|
942
|
+
"GET_RSP_FORMAT_BROKEN_REFERENCES",
|
|
943
|
+
],
|
|
944
|
+
type: "string",
|
|
945
|
+
},
|
|
946
|
+
"x-displayname": "Broken Referred Objects.",
|
|
947
|
+
},
|
|
948
|
+
],
|
|
949
|
+
requestBodySchema: null,
|
|
950
|
+
responseSchema: {
|
|
951
|
+
$ref: "#/components/schemas/k8s_cluster_role_bindingGetResponse",
|
|
952
|
+
},
|
|
953
|
+
requiredParams: ["name", "namespace"],
|
|
954
|
+
operationId: "ves.io.schema.k8s_cluster_role_binding.API.Get",
|
|
955
|
+
tags: ["Other"],
|
|
956
|
+
sourceFile: "domains/managed_kubernetes.json",
|
|
957
|
+
displayName: null,
|
|
958
|
+
dangerLevel: "low",
|
|
959
|
+
sideEffects: null,
|
|
960
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
961
|
+
cliExamples: [
|
|
962
|
+
{
|
|
963
|
+
command: "f5xcctl config k8s-cluster-role-binding get {name} --namespace {namespace}",
|
|
964
|
+
description: "Get specific k8s-cluster-role-binding",
|
|
965
|
+
use_case: "get_specific",
|
|
966
|
+
},
|
|
967
|
+
],
|
|
968
|
+
confirmationRequired: false,
|
|
969
|
+
parameterExamples: {
|
|
970
|
+
name: "Name",
|
|
971
|
+
namespace: "Ns1",
|
|
972
|
+
},
|
|
973
|
+
validationRules: {},
|
|
974
|
+
operationMetadata: {
|
|
975
|
+
common_errors: [
|
|
976
|
+
{
|
|
977
|
+
code: 401,
|
|
978
|
+
message: "Authentication required",
|
|
979
|
+
solution: "Provide valid API credentials",
|
|
980
|
+
},
|
|
981
|
+
{
|
|
982
|
+
code: 403,
|
|
983
|
+
message: "Permission denied",
|
|
984
|
+
solution: "Check access permissions for this operation",
|
|
985
|
+
},
|
|
986
|
+
{
|
|
987
|
+
code: 404,
|
|
988
|
+
message: "Resource not found",
|
|
989
|
+
solution: "Verify resource name, namespace, and path",
|
|
990
|
+
},
|
|
991
|
+
{
|
|
992
|
+
code: 409,
|
|
993
|
+
message: "Resource already exists",
|
|
994
|
+
solution: "Use different name or update existing resource",
|
|
995
|
+
},
|
|
996
|
+
{
|
|
997
|
+
code: 429,
|
|
998
|
+
message: "Rate limit exceeded",
|
|
999
|
+
solution: "Wait before retrying the operation",
|
|
1000
|
+
},
|
|
1001
|
+
{
|
|
1002
|
+
code: 500,
|
|
1003
|
+
message: "Server error",
|
|
1004
|
+
solution: "Retry operation or contact support",
|
|
1005
|
+
},
|
|
1006
|
+
],
|
|
1007
|
+
conditions: {
|
|
1008
|
+
postconditions: [],
|
|
1009
|
+
prerequisites: ["Active namespace"],
|
|
1010
|
+
},
|
|
1011
|
+
confirmation_required: false,
|
|
1012
|
+
danger_level: "low",
|
|
1013
|
+
examples: [
|
|
1014
|
+
{
|
|
1015
|
+
command: "f5xcctl config k8s-cluster-role-binding get {name} --namespace {namespace}",
|
|
1016
|
+
description: "Get specific k8s-cluster-role-binding",
|
|
1017
|
+
use_case: "get_specific",
|
|
1018
|
+
},
|
|
1019
|
+
],
|
|
1020
|
+
field_docs: {},
|
|
1021
|
+
optional_fields: [],
|
|
1022
|
+
performance_impact: {
|
|
1023
|
+
latency: "low",
|
|
1024
|
+
resource_usage: "low",
|
|
1025
|
+
},
|
|
1026
|
+
purpose: "Retrieve specific k8s-cluster-role-binding",
|
|
1027
|
+
required_fields: ["path.name", "path.namespace"],
|
|
1028
|
+
side_effects: {},
|
|
1029
|
+
},
|
|
1030
|
+
},
|
|
1031
|
+
{
|
|
1032
|
+
toolName: "f5xc-api-managedkubernetes-k8s-cluster-role-binding-list",
|
|
1033
|
+
method: "GET",
|
|
1034
|
+
path: "/api/config/namespaces/{namespace}/k8s_cluster_role_bindings",
|
|
1035
|
+
operation: "list",
|
|
1036
|
+
domain: "managed_kubernetes",
|
|
1037
|
+
resource: "k8s-cluster-role-binding",
|
|
1038
|
+
summary: "List K8s Cluster Role Binding.",
|
|
1039
|
+
description: "List the set of k8s_cluster_role_binding in a namespace.",
|
|
1040
|
+
pathParameters: [
|
|
1041
|
+
{
|
|
1042
|
+
description: "Namespace\nNamespace to scope the listing of k8s_cluster_role_binding.",
|
|
1043
|
+
in: "path",
|
|
1044
|
+
name: "namespace",
|
|
1045
|
+
required: true,
|
|
1046
|
+
schema: {
|
|
1047
|
+
type: "string",
|
|
1048
|
+
},
|
|
1049
|
+
"x-displayname": "Namespace",
|
|
1050
|
+
"x-ves-example": "Ns1",
|
|
1051
|
+
},
|
|
1052
|
+
],
|
|
1053
|
+
queryParameters: [
|
|
1054
|
+
{
|
|
1055
|
+
description: "A LabelSelectorType expression that every item in list response will satisfy.",
|
|
1056
|
+
in: "query",
|
|
1057
|
+
name: "label_filter",
|
|
1058
|
+
required: false,
|
|
1059
|
+
schema: {
|
|
1060
|
+
type: "string",
|
|
1061
|
+
},
|
|
1062
|
+
"x-displayname": "Label Filter.",
|
|
1063
|
+
"x-ves-example": "Env in (staging, testing), tier in (web, db)",
|
|
1064
|
+
},
|
|
1065
|
+
{
|
|
1066
|
+
description: 'X-example: ""\nExtra fields to return along with summary fields.',
|
|
1067
|
+
in: "query",
|
|
1068
|
+
name: "report_fields",
|
|
1069
|
+
required: false,
|
|
1070
|
+
schema: {
|
|
1071
|
+
items: {
|
|
1072
|
+
type: "string",
|
|
1073
|
+
},
|
|
1074
|
+
type: "array",
|
|
1075
|
+
},
|
|
1076
|
+
"x-displayname": "Report Fields.",
|
|
1077
|
+
},
|
|
1078
|
+
{
|
|
1079
|
+
description: 'X-example: ""\nExtra status fields to return along with summary fields.',
|
|
1080
|
+
in: "query",
|
|
1081
|
+
name: "report_status_fields",
|
|
1082
|
+
required: false,
|
|
1083
|
+
schema: {
|
|
1084
|
+
items: {
|
|
1085
|
+
type: "string",
|
|
1086
|
+
},
|
|
1087
|
+
type: "array",
|
|
1088
|
+
},
|
|
1089
|
+
"x-displayname": "Report Status Fields.",
|
|
1090
|
+
},
|
|
1091
|
+
],
|
|
1092
|
+
requestBodySchema: null,
|
|
1093
|
+
responseSchema: {
|
|
1094
|
+
$ref: "#/components/schemas/k8s_cluster_role_bindingListResponse",
|
|
1095
|
+
},
|
|
1096
|
+
requiredParams: ["namespace"],
|
|
1097
|
+
operationId: "ves.io.schema.k8s_cluster_role_binding.API.List",
|
|
1098
|
+
tags: ["Other"],
|
|
1099
|
+
sourceFile: "domains/managed_kubernetes.json",
|
|
1100
|
+
displayName: null,
|
|
1101
|
+
dangerLevel: "low",
|
|
1102
|
+
sideEffects: null,
|
|
1103
|
+
requiredFields: ["path.namespace"],
|
|
1104
|
+
cliExamples: [
|
|
1105
|
+
{
|
|
1106
|
+
command: "f5xcctl config k8s-cluster-role-binding list --namespace {namespace}",
|
|
1107
|
+
description: "List all k8s-cluster-role-bindings",
|
|
1108
|
+
use_case: "list_all",
|
|
1109
|
+
},
|
|
1110
|
+
],
|
|
1111
|
+
confirmationRequired: false,
|
|
1112
|
+
parameterExamples: {
|
|
1113
|
+
label_filter: "Env in (staging, testing), tier in (web, db)",
|
|
1114
|
+
namespace: "Ns1",
|
|
1115
|
+
},
|
|
1116
|
+
validationRules: {},
|
|
1117
|
+
operationMetadata: {
|
|
1118
|
+
common_errors: [
|
|
1119
|
+
{
|
|
1120
|
+
code: 401,
|
|
1121
|
+
message: "Authentication required",
|
|
1122
|
+
solution: "Provide valid API credentials",
|
|
1123
|
+
},
|
|
1124
|
+
{
|
|
1125
|
+
code: 403,
|
|
1126
|
+
message: "Permission denied",
|
|
1127
|
+
solution: "Check access permissions for this operation",
|
|
1128
|
+
},
|
|
1129
|
+
{
|
|
1130
|
+
code: 404,
|
|
1131
|
+
message: "Resource not found",
|
|
1132
|
+
solution: "Verify resource name, namespace, and path",
|
|
1133
|
+
},
|
|
1134
|
+
{
|
|
1135
|
+
code: 409,
|
|
1136
|
+
message: "Resource already exists",
|
|
1137
|
+
solution: "Use different name or update existing resource",
|
|
1138
|
+
},
|
|
1139
|
+
{
|
|
1140
|
+
code: 429,
|
|
1141
|
+
message: "Rate limit exceeded",
|
|
1142
|
+
solution: "Wait before retrying the operation",
|
|
1143
|
+
},
|
|
1144
|
+
{
|
|
1145
|
+
code: 500,
|
|
1146
|
+
message: "Server error",
|
|
1147
|
+
solution: "Retry operation or contact support",
|
|
1148
|
+
},
|
|
1149
|
+
],
|
|
1150
|
+
conditions: {
|
|
1151
|
+
postconditions: [],
|
|
1152
|
+
prerequisites: ["Active namespace"],
|
|
1153
|
+
},
|
|
1154
|
+
confirmation_required: false,
|
|
1155
|
+
danger_level: "low",
|
|
1156
|
+
examples: [
|
|
1157
|
+
{
|
|
1158
|
+
command: "f5xcctl config k8s-cluster-role-binding list --namespace {namespace}",
|
|
1159
|
+
description: "List all k8s-cluster-role-bindings",
|
|
1160
|
+
use_case: "list_all",
|
|
1161
|
+
},
|
|
1162
|
+
],
|
|
1163
|
+
field_docs: {},
|
|
1164
|
+
optional_fields: [],
|
|
1165
|
+
performance_impact: {
|
|
1166
|
+
latency: "moderate",
|
|
1167
|
+
resource_usage: "moderate",
|
|
1168
|
+
},
|
|
1169
|
+
purpose: "List all k8s-cluster-role-bindings",
|
|
1170
|
+
required_fields: ["path.namespace"],
|
|
1171
|
+
side_effects: {},
|
|
1172
|
+
},
|
|
1173
|
+
},
|
|
1174
|
+
{
|
|
1175
|
+
toolName: "f5xc-api-managedkubernetes-k8s-cluster-role-binding-update",
|
|
1176
|
+
method: "PUT",
|
|
1177
|
+
path: "/api/config/namespaces/{metadata.namespace}/k8s_cluster_role_bindings/{metadata.name}",
|
|
1178
|
+
operation: "update",
|
|
1179
|
+
domain: "managed_kubernetes",
|
|
1180
|
+
resource: "k8s-cluster-role-binding",
|
|
1181
|
+
summary: "Replace Configuration Specification.",
|
|
1182
|
+
description: "Replacing an k8s_cluster_role_binding object will update the object by replacing the existing spec with the provided one.\nFor read-then-write operations a resourceVersion mismatch will occur if the object was modified between the read and write.",
|
|
1183
|
+
pathParameters: [
|
|
1184
|
+
{
|
|
1185
|
+
description: "Name\nThe configuration object to be replaced will be looked up by name.",
|
|
1186
|
+
in: "path",
|
|
1187
|
+
name: "metadata.name",
|
|
1188
|
+
required: true,
|
|
1189
|
+
schema: {
|
|
1190
|
+
type: "string",
|
|
1191
|
+
},
|
|
1192
|
+
"x-displayname": "Name",
|
|
1193
|
+
"x-ves-example": "Example-corp-web.",
|
|
1194
|
+
},
|
|
1195
|
+
{
|
|
1196
|
+
description: 'Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be ""',
|
|
1197
|
+
in: "path",
|
|
1198
|
+
name: "metadata.namespace",
|
|
1199
|
+
required: true,
|
|
1200
|
+
schema: {
|
|
1201
|
+
type: "string",
|
|
1202
|
+
},
|
|
1203
|
+
"x-displayname": "Namespace",
|
|
1204
|
+
"x-ves-example": "Staging",
|
|
1205
|
+
},
|
|
1206
|
+
],
|
|
1207
|
+
queryParameters: [],
|
|
1208
|
+
requestBodySchema: {
|
|
1209
|
+
$ref: "#/components/schemas/k8s_cluster_role_bindingReplaceRequest",
|
|
1210
|
+
},
|
|
1211
|
+
responseSchema: {
|
|
1212
|
+
$ref: "#/components/schemas/k8s_cluster_role_bindingReplaceResponse",
|
|
1213
|
+
},
|
|
1214
|
+
requiredParams: ["body", "metadata.name", "metadata.namespace"],
|
|
1215
|
+
operationId: "ves.io.schema.k8s_cluster_role_binding.API.Replace",
|
|
1216
|
+
tags: ["Other"],
|
|
1217
|
+
sourceFile: "domains/managed_kubernetes.json",
|
|
1218
|
+
displayName: null,
|
|
1219
|
+
dangerLevel: "medium",
|
|
1220
|
+
sideEffects: {
|
|
1221
|
+
modifies: ["k8s-cluster-role-binding"],
|
|
1222
|
+
},
|
|
1223
|
+
requiredFields: ["path.metadata.name", "path.metadata.namespace"],
|
|
1224
|
+
cliExamples: [
|
|
1225
|
+
{
|
|
1226
|
+
command: "f5xcctl config k8s-cluster-role-binding update {name} --namespace {namespace} -f {file}.yaml",
|
|
1227
|
+
description: "Update k8s-cluster-role-binding",
|
|
1228
|
+
use_case: "update",
|
|
1229
|
+
},
|
|
1230
|
+
],
|
|
1231
|
+
confirmationRequired: false,
|
|
1232
|
+
parameterExamples: {
|
|
1233
|
+
"metadata.name": "Example-corp-web.",
|
|
1234
|
+
"metadata.namespace": "Staging",
|
|
1235
|
+
},
|
|
1236
|
+
validationRules: {},
|
|
1237
|
+
operationMetadata: {
|
|
1238
|
+
common_errors: [
|
|
1239
|
+
{
|
|
1240
|
+
code: 401,
|
|
1241
|
+
message: "Authentication required",
|
|
1242
|
+
solution: "Provide valid API credentials",
|
|
1243
|
+
},
|
|
1244
|
+
{
|
|
1245
|
+
code: 403,
|
|
1246
|
+
message: "Permission denied",
|
|
1247
|
+
solution: "Check access permissions for this operation",
|
|
1248
|
+
},
|
|
1249
|
+
{
|
|
1250
|
+
code: 404,
|
|
1251
|
+
message: "Resource not found",
|
|
1252
|
+
solution: "Verify resource name, namespace, and path",
|
|
1253
|
+
},
|
|
1254
|
+
{
|
|
1255
|
+
code: 409,
|
|
1256
|
+
message: "Resource already exists",
|
|
1257
|
+
solution: "Use different name or update existing resource",
|
|
1258
|
+
},
|
|
1259
|
+
{
|
|
1260
|
+
code: 429,
|
|
1261
|
+
message: "Rate limit exceeded",
|
|
1262
|
+
solution: "Wait before retrying the operation",
|
|
1263
|
+
},
|
|
1264
|
+
{
|
|
1265
|
+
code: 500,
|
|
1266
|
+
message: "Server error",
|
|
1267
|
+
solution: "Retry operation or contact support",
|
|
1268
|
+
},
|
|
1269
|
+
],
|
|
1270
|
+
conditions: {
|
|
1271
|
+
postconditions: ["Resource updated with new values"],
|
|
1272
|
+
prerequisites: ["Active namespace"],
|
|
1273
|
+
},
|
|
1274
|
+
confirmation_required: false,
|
|
1275
|
+
danger_level: "medium",
|
|
1276
|
+
examples: [
|
|
1277
|
+
{
|
|
1278
|
+
command: "f5xcctl config k8s-cluster-role-binding update {name} --namespace {namespace} -f {file}.yaml",
|
|
1279
|
+
description: "Update k8s-cluster-role-binding",
|
|
1280
|
+
use_case: "update",
|
|
1281
|
+
},
|
|
1282
|
+
],
|
|
1283
|
+
field_docs: {},
|
|
1284
|
+
optional_fields: [],
|
|
1285
|
+
performance_impact: {
|
|
1286
|
+
latency: "low",
|
|
1287
|
+
resource_usage: "low",
|
|
1288
|
+
},
|
|
1289
|
+
purpose: "Replace existing k8s-cluster-role-binding",
|
|
1290
|
+
required_fields: ["path.metadata.name", "path.metadata.namespace"],
|
|
1291
|
+
side_effects: {
|
|
1292
|
+
modifies: ["k8s-cluster-role-binding"],
|
|
1293
|
+
},
|
|
1294
|
+
},
|
|
1295
|
+
},
|
|
1296
|
+
{
|
|
1297
|
+
toolName: "f5xc-api-managedkubernetes-k8s-cluster-role-create",
|
|
1298
|
+
method: "POST",
|
|
1299
|
+
path: "/api/config/namespaces/{metadata.namespace}/k8s_cluster_roles",
|
|
1300
|
+
operation: "create",
|
|
1301
|
+
domain: "managed_kubernetes",
|
|
1302
|
+
resource: "k8s-cluster-role",
|
|
1303
|
+
summary: "Create Configuration Specification.",
|
|
1304
|
+
description: "Create k8s_cluster_role will create the object in the storage backend for namespace metadata.namespace.",
|
|
1305
|
+
pathParameters: [
|
|
1306
|
+
{
|
|
1307
|
+
description: 'Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be ""',
|
|
1308
|
+
in: "path",
|
|
1309
|
+
name: "metadata.namespace",
|
|
1310
|
+
required: true,
|
|
1311
|
+
schema: {
|
|
1312
|
+
type: "string",
|
|
1313
|
+
},
|
|
1314
|
+
"x-displayname": "Namespace",
|
|
1315
|
+
"x-ves-example": "Staging",
|
|
1316
|
+
},
|
|
1317
|
+
],
|
|
1318
|
+
queryParameters: [],
|
|
1319
|
+
requestBodySchema: {
|
|
1320
|
+
$ref: "#/components/schemas/k8s_cluster_roleCreateRequest",
|
|
1321
|
+
},
|
|
1322
|
+
responseSchema: {
|
|
1323
|
+
$ref: "#/components/schemas/k8s_cluster_roleCreateResponse",
|
|
1324
|
+
},
|
|
1325
|
+
requiredParams: ["body", "metadata.namespace"],
|
|
1326
|
+
operationId: "ves.io.schema.k8s_cluster_role.API.Create",
|
|
1327
|
+
tags: ["Other"],
|
|
1328
|
+
sourceFile: "domains/managed_kubernetes.json",
|
|
1329
|
+
displayName: null,
|
|
1330
|
+
dangerLevel: "medium",
|
|
1331
|
+
sideEffects: {
|
|
1332
|
+
creates: ["k8s-cluster-role"],
|
|
1333
|
+
},
|
|
1334
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
1335
|
+
cliExamples: [
|
|
1336
|
+
{
|
|
1337
|
+
command: "f5xcctl config k8s-cluster-role create -f {file}.yaml",
|
|
1338
|
+
description: "Create from YAML file",
|
|
1339
|
+
use_case: "file_based",
|
|
1340
|
+
},
|
|
1341
|
+
{
|
|
1342
|
+
command: "f5xcctl config k8s-cluster-role create {name} --namespace {namespace}",
|
|
1343
|
+
description: "Create k8s-cluster-role",
|
|
1344
|
+
use_case: "basic_create",
|
|
1345
|
+
},
|
|
1346
|
+
],
|
|
1347
|
+
confirmationRequired: false,
|
|
1348
|
+
parameterExamples: {
|
|
1349
|
+
"metadata.namespace": "Staging",
|
|
1350
|
+
},
|
|
1351
|
+
validationRules: {},
|
|
1352
|
+
operationMetadata: {
|
|
1353
|
+
common_errors: [
|
|
1354
|
+
{
|
|
1355
|
+
code: 401,
|
|
1356
|
+
message: "Authentication required",
|
|
1357
|
+
solution: "Provide valid API credentials",
|
|
1358
|
+
},
|
|
1359
|
+
{
|
|
1360
|
+
code: 403,
|
|
1361
|
+
message: "Permission denied",
|
|
1362
|
+
solution: "Check access permissions for this operation",
|
|
1363
|
+
},
|
|
1364
|
+
{
|
|
1365
|
+
code: 404,
|
|
1366
|
+
message: "Resource not found",
|
|
1367
|
+
solution: "Verify resource name, namespace, and path",
|
|
1368
|
+
},
|
|
1369
|
+
{
|
|
1370
|
+
code: 409,
|
|
1371
|
+
message: "Resource already exists",
|
|
1372
|
+
solution: "Use different name or update existing resource",
|
|
1373
|
+
},
|
|
1374
|
+
{
|
|
1375
|
+
code: 429,
|
|
1376
|
+
message: "Rate limit exceeded",
|
|
1377
|
+
solution: "Wait before retrying the operation",
|
|
1378
|
+
},
|
|
1379
|
+
{
|
|
1380
|
+
code: 500,
|
|
1381
|
+
message: "Server error",
|
|
1382
|
+
solution: "Retry operation or contact support",
|
|
1383
|
+
},
|
|
1384
|
+
],
|
|
1385
|
+
conditions: {
|
|
1386
|
+
postconditions: [
|
|
1387
|
+
"K8s-cluster-role resource created",
|
|
1388
|
+
"Resource assigned unique identifier",
|
|
1389
|
+
],
|
|
1390
|
+
prerequisites: ["Active namespace"],
|
|
1391
|
+
},
|
|
1392
|
+
confirmation_required: false,
|
|
1393
|
+
danger_level: "medium",
|
|
1394
|
+
examples: [
|
|
1395
|
+
{
|
|
1396
|
+
command: "f5xcctl config k8s-cluster-role create {name} --namespace {namespace}",
|
|
1397
|
+
description: "Create k8s-cluster-role",
|
|
1398
|
+
use_case: "basic_create",
|
|
1399
|
+
},
|
|
1400
|
+
{
|
|
1401
|
+
command: "f5xcctl config k8s-cluster-role create -f {file}.yaml",
|
|
1402
|
+
description: "Create from YAML file",
|
|
1403
|
+
use_case: "file_based",
|
|
1404
|
+
},
|
|
1405
|
+
],
|
|
1406
|
+
field_docs: {},
|
|
1407
|
+
optional_fields: [],
|
|
1408
|
+
performance_impact: {
|
|
1409
|
+
latency: "low",
|
|
1410
|
+
resource_usage: "low",
|
|
1411
|
+
},
|
|
1412
|
+
purpose: "Create new k8s-cluster-role",
|
|
1413
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
1414
|
+
side_effects: {
|
|
1415
|
+
creates: ["k8s-cluster-role"],
|
|
1416
|
+
},
|
|
1417
|
+
},
|
|
1418
|
+
},
|
|
1419
|
+
{
|
|
1420
|
+
toolName: "f5xc-api-managedkubernetes-k8s-cluster-role-delete",
|
|
1421
|
+
method: "DELETE",
|
|
1422
|
+
path: "/api/config/namespaces/{namespace}/k8s_cluster_roles/{name}",
|
|
1423
|
+
operation: "delete",
|
|
1424
|
+
domain: "managed_kubernetes",
|
|
1425
|
+
resource: "k8s-cluster-role",
|
|
1426
|
+
summary: "DELETE K8s Cluster Role.",
|
|
1427
|
+
description: "DELETE the specified k8s_cluster_role.",
|
|
1428
|
+
pathParameters: [
|
|
1429
|
+
{
|
|
1430
|
+
description: "Name\nName of the configuration object.",
|
|
1431
|
+
in: "path",
|
|
1432
|
+
name: "name",
|
|
1433
|
+
required: true,
|
|
1434
|
+
schema: {
|
|
1435
|
+
type: "string",
|
|
1436
|
+
},
|
|
1437
|
+
"x-displayname": "Name",
|
|
1438
|
+
"x-ves-example": "Name",
|
|
1439
|
+
},
|
|
1440
|
+
{
|
|
1441
|
+
description: "Namespace\nNamespace in which the configuration object is present.",
|
|
1442
|
+
in: "path",
|
|
1443
|
+
name: "namespace",
|
|
1444
|
+
required: true,
|
|
1445
|
+
schema: {
|
|
1446
|
+
type: "string",
|
|
1447
|
+
},
|
|
1448
|
+
"x-displayname": "Namespace",
|
|
1449
|
+
"x-ves-example": "Ns1",
|
|
1450
|
+
},
|
|
1451
|
+
],
|
|
1452
|
+
queryParameters: [],
|
|
1453
|
+
requestBodySchema: {
|
|
1454
|
+
$ref: "#/components/schemas/k8s_cluster_roleDeleteRequest",
|
|
1455
|
+
},
|
|
1456
|
+
responseSchema: {},
|
|
1457
|
+
requiredParams: ["body", "name", "namespace"],
|
|
1458
|
+
operationId: "ves.io.schema.k8s_cluster_role.API.Delete",
|
|
1459
|
+
tags: ["Other"],
|
|
1460
|
+
sourceFile: "domains/managed_kubernetes.json",
|
|
1461
|
+
displayName: null,
|
|
1462
|
+
dangerLevel: "high",
|
|
1463
|
+
sideEffects: {
|
|
1464
|
+
deletes: ["k8s-cluster-role", "contained_resources"],
|
|
1465
|
+
},
|
|
1466
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
1467
|
+
cliExamples: [
|
|
1468
|
+
{
|
|
1469
|
+
command: "f5xcctl config k8s-cluster-role delete {name} --namespace {namespace}",
|
|
1470
|
+
description: "Delete k8s-cluster-role",
|
|
1471
|
+
use_case: "delete",
|
|
1472
|
+
},
|
|
1473
|
+
],
|
|
1474
|
+
confirmationRequired: true,
|
|
1475
|
+
parameterExamples: {
|
|
1476
|
+
name: "Name",
|
|
1477
|
+
namespace: "Ns1",
|
|
1478
|
+
},
|
|
1479
|
+
validationRules: {},
|
|
1480
|
+
operationMetadata: {
|
|
1481
|
+
common_errors: [
|
|
1482
|
+
{
|
|
1483
|
+
code: 401,
|
|
1484
|
+
message: "Authentication required",
|
|
1485
|
+
solution: "Provide valid API credentials",
|
|
1486
|
+
},
|
|
1487
|
+
{
|
|
1488
|
+
code: 403,
|
|
1489
|
+
message: "Permission denied",
|
|
1490
|
+
solution: "Check access permissions for this operation",
|
|
1491
|
+
},
|
|
1492
|
+
{
|
|
1493
|
+
code: 404,
|
|
1494
|
+
message: "Resource not found",
|
|
1495
|
+
solution: "Verify resource name, namespace, and path",
|
|
1496
|
+
},
|
|
1497
|
+
{
|
|
1498
|
+
code: 409,
|
|
1499
|
+
message: "Resource already exists",
|
|
1500
|
+
solution: "Use different name or update existing resource",
|
|
1501
|
+
},
|
|
1502
|
+
{
|
|
1503
|
+
code: 429,
|
|
1504
|
+
message: "Rate limit exceeded",
|
|
1505
|
+
solution: "Wait before retrying the operation",
|
|
1506
|
+
},
|
|
1507
|
+
{
|
|
1508
|
+
code: 500,
|
|
1509
|
+
message: "Server error",
|
|
1510
|
+
solution: "Retry operation or contact support",
|
|
1511
|
+
},
|
|
1512
|
+
],
|
|
1513
|
+
conditions: {
|
|
1514
|
+
postconditions: ["Resource removed from system", "Associated resources may be affected"],
|
|
1515
|
+
prerequisites: ["Active namespace"],
|
|
1516
|
+
},
|
|
1517
|
+
confirmation_required: true,
|
|
1518
|
+
danger_level: "high",
|
|
1519
|
+
examples: [
|
|
1520
|
+
{
|
|
1521
|
+
command: "f5xcctl config k8s-cluster-role delete {name} --namespace {namespace}",
|
|
1522
|
+
description: "Delete k8s-cluster-role",
|
|
1523
|
+
use_case: "delete",
|
|
1524
|
+
},
|
|
1525
|
+
],
|
|
1526
|
+
field_docs: {},
|
|
1527
|
+
optional_fields: [],
|
|
1528
|
+
performance_impact: {
|
|
1529
|
+
latency: "high",
|
|
1530
|
+
resource_usage: "moderate",
|
|
1531
|
+
},
|
|
1532
|
+
purpose: "Delete k8s-cluster-role",
|
|
1533
|
+
required_fields: ["path.name", "path.namespace"],
|
|
1534
|
+
side_effects: {
|
|
1535
|
+
deletes: ["k8s-cluster-role", "contained_resources"],
|
|
1536
|
+
},
|
|
1537
|
+
},
|
|
1538
|
+
},
|
|
1539
|
+
{
|
|
1540
|
+
toolName: "f5xc-api-managedkubernetes-k8s-cluster-role-get",
|
|
1541
|
+
method: "GET",
|
|
1542
|
+
path: "/api/config/namespaces/{namespace}/k8s_cluster_roles/{name}",
|
|
1543
|
+
operation: "get",
|
|
1544
|
+
domain: "managed_kubernetes",
|
|
1545
|
+
resource: "k8s-cluster-role",
|
|
1546
|
+
summary: "GET Configuration Specification.",
|
|
1547
|
+
description: "GET k8s_cluster_role will GET the object from the storage backend for namespace metadata.namespace.",
|
|
1548
|
+
pathParameters: [
|
|
1549
|
+
{
|
|
1550
|
+
description: "Name\nThe name of the configuration object to be fetched.",
|
|
1551
|
+
in: "path",
|
|
1552
|
+
name: "name",
|
|
1553
|
+
required: true,
|
|
1554
|
+
schema: {
|
|
1555
|
+
type: "string",
|
|
1556
|
+
},
|
|
1557
|
+
"x-displayname": "Name",
|
|
1558
|
+
"x-ves-example": "Name",
|
|
1559
|
+
},
|
|
1560
|
+
{
|
|
1561
|
+
description: "Namespace\nThe namespace in which the configuration object is present.",
|
|
1562
|
+
in: "path",
|
|
1563
|
+
name: "namespace",
|
|
1564
|
+
required: true,
|
|
1565
|
+
schema: {
|
|
1566
|
+
type: "string",
|
|
1567
|
+
},
|
|
1568
|
+
"x-displayname": "Namespace",
|
|
1569
|
+
"x-ves-example": "Ns1",
|
|
1570
|
+
},
|
|
1571
|
+
],
|
|
1572
|
+
queryParameters: [
|
|
1573
|
+
{
|
|
1574
|
+
description: "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referrred by this object.",
|
|
1575
|
+
in: "query",
|
|
1576
|
+
name: "response_format",
|
|
1577
|
+
required: false,
|
|
1578
|
+
schema: {
|
|
1579
|
+
default: "GET_RSP_FORMAT_DEFAULT",
|
|
1580
|
+
enum: [
|
|
1581
|
+
"GET_RSP_FORMAT_DEFAULT",
|
|
1582
|
+
"GET_RSP_FORMAT_FOR_CREATE",
|
|
1583
|
+
"GET_RSP_FORMAT_FOR_REPLACE",
|
|
1584
|
+
"GET_RSP_FORMAT_STATUS",
|
|
1585
|
+
"GET_RSP_FORMAT_READ",
|
|
1586
|
+
"GET_RSP_FORMAT_REFERRING_OBJECTS",
|
|
1587
|
+
"GET_RSP_FORMAT_BROKEN_REFERENCES",
|
|
1588
|
+
],
|
|
1589
|
+
type: "string",
|
|
1590
|
+
},
|
|
1591
|
+
"x-displayname": "Broken Referred Objects.",
|
|
1592
|
+
},
|
|
1593
|
+
],
|
|
1594
|
+
requestBodySchema: null,
|
|
1595
|
+
responseSchema: {
|
|
1596
|
+
$ref: "#/components/schemas/k8s_cluster_roleGetResponse",
|
|
1597
|
+
},
|
|
1598
|
+
requiredParams: ["name", "namespace"],
|
|
1599
|
+
operationId: "ves.io.schema.k8s_cluster_role.API.Get",
|
|
1600
|
+
tags: ["Other"],
|
|
1601
|
+
sourceFile: "domains/managed_kubernetes.json",
|
|
1602
|
+
displayName: null,
|
|
1603
|
+
dangerLevel: "low",
|
|
1604
|
+
sideEffects: null,
|
|
1605
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
1606
|
+
cliExamples: [
|
|
1607
|
+
{
|
|
1608
|
+
command: "f5xcctl config k8s-cluster-role get {name} --namespace {namespace}",
|
|
1609
|
+
description: "Get specific k8s-cluster-role",
|
|
1610
|
+
use_case: "get_specific",
|
|
1611
|
+
},
|
|
1612
|
+
],
|
|
1613
|
+
confirmationRequired: false,
|
|
1614
|
+
parameterExamples: {
|
|
1615
|
+
name: "Name",
|
|
1616
|
+
namespace: "Ns1",
|
|
1617
|
+
},
|
|
1618
|
+
validationRules: {},
|
|
1619
|
+
operationMetadata: {
|
|
1620
|
+
common_errors: [
|
|
1621
|
+
{
|
|
1622
|
+
code: 401,
|
|
1623
|
+
message: "Authentication required",
|
|
1624
|
+
solution: "Provide valid API credentials",
|
|
1625
|
+
},
|
|
1626
|
+
{
|
|
1627
|
+
code: 403,
|
|
1628
|
+
message: "Permission denied",
|
|
1629
|
+
solution: "Check access permissions for this operation",
|
|
1630
|
+
},
|
|
1631
|
+
{
|
|
1632
|
+
code: 404,
|
|
1633
|
+
message: "Resource not found",
|
|
1634
|
+
solution: "Verify resource name, namespace, and path",
|
|
1635
|
+
},
|
|
1636
|
+
{
|
|
1637
|
+
code: 409,
|
|
1638
|
+
message: "Resource already exists",
|
|
1639
|
+
solution: "Use different name or update existing resource",
|
|
1640
|
+
},
|
|
1641
|
+
{
|
|
1642
|
+
code: 429,
|
|
1643
|
+
message: "Rate limit exceeded",
|
|
1644
|
+
solution: "Wait before retrying the operation",
|
|
1645
|
+
},
|
|
1646
|
+
{
|
|
1647
|
+
code: 500,
|
|
1648
|
+
message: "Server error",
|
|
1649
|
+
solution: "Retry operation or contact support",
|
|
1650
|
+
},
|
|
1651
|
+
],
|
|
1652
|
+
conditions: {
|
|
1653
|
+
postconditions: [],
|
|
1654
|
+
prerequisites: ["Active namespace"],
|
|
1655
|
+
},
|
|
1656
|
+
confirmation_required: false,
|
|
1657
|
+
danger_level: "low",
|
|
1658
|
+
examples: [
|
|
1659
|
+
{
|
|
1660
|
+
command: "f5xcctl config k8s-cluster-role get {name} --namespace {namespace}",
|
|
1661
|
+
description: "Get specific k8s-cluster-role",
|
|
1662
|
+
use_case: "get_specific",
|
|
1663
|
+
},
|
|
1664
|
+
],
|
|
1665
|
+
field_docs: {},
|
|
1666
|
+
optional_fields: [],
|
|
1667
|
+
performance_impact: {
|
|
1668
|
+
latency: "low",
|
|
1669
|
+
resource_usage: "low",
|
|
1670
|
+
},
|
|
1671
|
+
purpose: "Retrieve specific k8s-cluster-role",
|
|
1672
|
+
required_fields: ["path.name", "path.namespace"],
|
|
1673
|
+
side_effects: {},
|
|
1674
|
+
},
|
|
1675
|
+
},
|
|
1676
|
+
{
|
|
1677
|
+
toolName: "f5xc-api-managedkubernetes-k8s-cluster-role-list",
|
|
1678
|
+
method: "GET",
|
|
1679
|
+
path: "/api/config/namespaces/{namespace}/k8s_cluster_roles",
|
|
1680
|
+
operation: "list",
|
|
1681
|
+
domain: "managed_kubernetes",
|
|
1682
|
+
resource: "k8s-cluster-role",
|
|
1683
|
+
summary: "List K8s Cluster Role.",
|
|
1684
|
+
description: "List the set of k8s_cluster_role in a namespace.",
|
|
1685
|
+
pathParameters: [
|
|
1686
|
+
{
|
|
1687
|
+
description: "Namespace\nNamespace to scope the listing of k8s_cluster_role.",
|
|
1688
|
+
in: "path",
|
|
1689
|
+
name: "namespace",
|
|
1690
|
+
required: true,
|
|
1691
|
+
schema: {
|
|
1692
|
+
type: "string",
|
|
1693
|
+
},
|
|
1694
|
+
"x-displayname": "Namespace",
|
|
1695
|
+
"x-ves-example": "Ns1",
|
|
1696
|
+
},
|
|
1697
|
+
],
|
|
1698
|
+
queryParameters: [
|
|
1699
|
+
{
|
|
1700
|
+
description: "A LabelSelectorType expression that every item in list response will satisfy.",
|
|
1701
|
+
in: "query",
|
|
1702
|
+
name: "label_filter",
|
|
1703
|
+
required: false,
|
|
1704
|
+
schema: {
|
|
1705
|
+
type: "string",
|
|
1706
|
+
},
|
|
1707
|
+
"x-displayname": "Label Filter.",
|
|
1708
|
+
"x-ves-example": "Env in (staging, testing), tier in (web, db)",
|
|
1709
|
+
},
|
|
1710
|
+
{
|
|
1711
|
+
description: 'X-example: ""\nExtra fields to return along with summary fields.',
|
|
1712
|
+
in: "query",
|
|
1713
|
+
name: "report_fields",
|
|
1714
|
+
required: false,
|
|
1715
|
+
schema: {
|
|
1716
|
+
items: {
|
|
1717
|
+
type: "string",
|
|
1718
|
+
},
|
|
1719
|
+
type: "array",
|
|
1720
|
+
},
|
|
1721
|
+
"x-displayname": "Report Fields.",
|
|
1722
|
+
},
|
|
1723
|
+
{
|
|
1724
|
+
description: 'X-example: ""\nExtra status fields to return along with summary fields.',
|
|
1725
|
+
in: "query",
|
|
1726
|
+
name: "report_status_fields",
|
|
1727
|
+
required: false,
|
|
1728
|
+
schema: {
|
|
1729
|
+
items: {
|
|
1730
|
+
type: "string",
|
|
1731
|
+
},
|
|
1732
|
+
type: "array",
|
|
1733
|
+
},
|
|
1734
|
+
"x-displayname": "Report Status Fields.",
|
|
1735
|
+
},
|
|
1736
|
+
],
|
|
1737
|
+
requestBodySchema: null,
|
|
1738
|
+
responseSchema: {
|
|
1739
|
+
$ref: "#/components/schemas/k8s_cluster_roleListResponse",
|
|
1740
|
+
},
|
|
1741
|
+
requiredParams: ["namespace"],
|
|
1742
|
+
operationId: "ves.io.schema.k8s_cluster_role.API.List",
|
|
1743
|
+
tags: ["Other"],
|
|
1744
|
+
sourceFile: "domains/managed_kubernetes.json",
|
|
1745
|
+
displayName: null,
|
|
1746
|
+
dangerLevel: "low",
|
|
1747
|
+
sideEffects: null,
|
|
1748
|
+
requiredFields: ["path.namespace"],
|
|
1749
|
+
cliExamples: [
|
|
1750
|
+
{
|
|
1751
|
+
command: "f5xcctl config k8s-cluster-role list --namespace {namespace}",
|
|
1752
|
+
description: "List all k8s-cluster-roles",
|
|
1753
|
+
use_case: "list_all",
|
|
1754
|
+
},
|
|
1755
|
+
],
|
|
1756
|
+
confirmationRequired: false,
|
|
1757
|
+
parameterExamples: {
|
|
1758
|
+
label_filter: "Env in (staging, testing), tier in (web, db)",
|
|
1759
|
+
namespace: "Ns1",
|
|
1760
|
+
},
|
|
1761
|
+
validationRules: {},
|
|
1762
|
+
operationMetadata: {
|
|
1763
|
+
common_errors: [
|
|
1764
|
+
{
|
|
1765
|
+
code: 401,
|
|
1766
|
+
message: "Authentication required",
|
|
1767
|
+
solution: "Provide valid API credentials",
|
|
1768
|
+
},
|
|
1769
|
+
{
|
|
1770
|
+
code: 403,
|
|
1771
|
+
message: "Permission denied",
|
|
1772
|
+
solution: "Check access permissions for this operation",
|
|
1773
|
+
},
|
|
1774
|
+
{
|
|
1775
|
+
code: 404,
|
|
1776
|
+
message: "Resource not found",
|
|
1777
|
+
solution: "Verify resource name, namespace, and path",
|
|
1778
|
+
},
|
|
1779
|
+
{
|
|
1780
|
+
code: 409,
|
|
1781
|
+
message: "Resource already exists",
|
|
1782
|
+
solution: "Use different name or update existing resource",
|
|
1783
|
+
},
|
|
1784
|
+
{
|
|
1785
|
+
code: 429,
|
|
1786
|
+
message: "Rate limit exceeded",
|
|
1787
|
+
solution: "Wait before retrying the operation",
|
|
1788
|
+
},
|
|
1789
|
+
{
|
|
1790
|
+
code: 500,
|
|
1791
|
+
message: "Server error",
|
|
1792
|
+
solution: "Retry operation or contact support",
|
|
1793
|
+
},
|
|
1794
|
+
],
|
|
1795
|
+
conditions: {
|
|
1796
|
+
postconditions: [],
|
|
1797
|
+
prerequisites: ["Active namespace"],
|
|
1798
|
+
},
|
|
1799
|
+
confirmation_required: false,
|
|
1800
|
+
danger_level: "low",
|
|
1801
|
+
examples: [
|
|
1802
|
+
{
|
|
1803
|
+
command: "f5xcctl config k8s-cluster-role list --namespace {namespace}",
|
|
1804
|
+
description: "List all k8s-cluster-roles",
|
|
1805
|
+
use_case: "list_all",
|
|
1806
|
+
},
|
|
1807
|
+
],
|
|
1808
|
+
field_docs: {},
|
|
1809
|
+
optional_fields: [],
|
|
1810
|
+
performance_impact: {
|
|
1811
|
+
latency: "moderate",
|
|
1812
|
+
resource_usage: "moderate",
|
|
1813
|
+
},
|
|
1814
|
+
purpose: "List all k8s-cluster-roles",
|
|
1815
|
+
required_fields: ["path.namespace"],
|
|
1816
|
+
side_effects: {},
|
|
1817
|
+
},
|
|
1818
|
+
},
|
|
1819
|
+
{
|
|
1820
|
+
toolName: "f5xc-api-managedkubernetes-k8s-cluster-role-update",
|
|
1821
|
+
method: "PUT",
|
|
1822
|
+
path: "/api/config/namespaces/{metadata.namespace}/k8s_cluster_roles/{metadata.name}",
|
|
1823
|
+
operation: "update",
|
|
1824
|
+
domain: "managed_kubernetes",
|
|
1825
|
+
resource: "k8s-cluster-role",
|
|
1826
|
+
summary: "Replace Configuration Specification.",
|
|
1827
|
+
description: "Replacing an k8s_cluster_role object will update the object by replacing the existing spec with the provided one.\nFor read-then-write operations a resourceVersion mismatch will occur if the object was modified between the read and write.",
|
|
1828
|
+
pathParameters: [
|
|
1829
|
+
{
|
|
1830
|
+
description: "Name\nThe configuration object to be replaced will be looked up by name.",
|
|
1831
|
+
in: "path",
|
|
1832
|
+
name: "metadata.name",
|
|
1833
|
+
required: true,
|
|
1834
|
+
schema: {
|
|
1835
|
+
type: "string",
|
|
1836
|
+
},
|
|
1837
|
+
"x-displayname": "Name",
|
|
1838
|
+
"x-ves-example": "Example-corp-web.",
|
|
1839
|
+
},
|
|
1840
|
+
{
|
|
1841
|
+
description: 'Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be ""',
|
|
1842
|
+
in: "path",
|
|
1843
|
+
name: "metadata.namespace",
|
|
1844
|
+
required: true,
|
|
1845
|
+
schema: {
|
|
1846
|
+
type: "string",
|
|
1847
|
+
},
|
|
1848
|
+
"x-displayname": "Namespace",
|
|
1849
|
+
"x-ves-example": "Staging",
|
|
1850
|
+
},
|
|
1851
|
+
],
|
|
1852
|
+
queryParameters: [],
|
|
1853
|
+
requestBodySchema: {
|
|
1854
|
+
$ref: "#/components/schemas/k8s_cluster_roleReplaceRequest",
|
|
1855
|
+
},
|
|
1856
|
+
responseSchema: {
|
|
1857
|
+
$ref: "#/components/schemas/k8s_cluster_roleReplaceResponse",
|
|
1858
|
+
},
|
|
1859
|
+
requiredParams: ["body", "metadata.name", "metadata.namespace"],
|
|
1860
|
+
operationId: "ves.io.schema.k8s_cluster_role.API.Replace",
|
|
1861
|
+
tags: ["Other"],
|
|
1862
|
+
sourceFile: "domains/managed_kubernetes.json",
|
|
1863
|
+
displayName: null,
|
|
1864
|
+
dangerLevel: "medium",
|
|
1865
|
+
sideEffects: {
|
|
1866
|
+
modifies: ["k8s-cluster-role"],
|
|
1867
|
+
},
|
|
1868
|
+
requiredFields: ["path.metadata.name", "path.metadata.namespace"],
|
|
1869
|
+
cliExamples: [
|
|
1870
|
+
{
|
|
1871
|
+
command: "f5xcctl config k8s-cluster-role update {name} --namespace {namespace} -f {file}.yaml",
|
|
1872
|
+
description: "Update k8s-cluster-role",
|
|
1873
|
+
use_case: "update",
|
|
1874
|
+
},
|
|
1875
|
+
],
|
|
1876
|
+
confirmationRequired: false,
|
|
1877
|
+
parameterExamples: {
|
|
1878
|
+
"metadata.name": "Example-corp-web.",
|
|
1879
|
+
"metadata.namespace": "Staging",
|
|
1880
|
+
},
|
|
1881
|
+
validationRules: {},
|
|
1882
|
+
operationMetadata: {
|
|
1883
|
+
common_errors: [
|
|
1884
|
+
{
|
|
1885
|
+
code: 401,
|
|
1886
|
+
message: "Authentication required",
|
|
1887
|
+
solution: "Provide valid API credentials",
|
|
1888
|
+
},
|
|
1889
|
+
{
|
|
1890
|
+
code: 403,
|
|
1891
|
+
message: "Permission denied",
|
|
1892
|
+
solution: "Check access permissions for this operation",
|
|
1893
|
+
},
|
|
1894
|
+
{
|
|
1895
|
+
code: 404,
|
|
1896
|
+
message: "Resource not found",
|
|
1897
|
+
solution: "Verify resource name, namespace, and path",
|
|
1898
|
+
},
|
|
1899
|
+
{
|
|
1900
|
+
code: 409,
|
|
1901
|
+
message: "Resource already exists",
|
|
1902
|
+
solution: "Use different name or update existing resource",
|
|
1903
|
+
},
|
|
1904
|
+
{
|
|
1905
|
+
code: 429,
|
|
1906
|
+
message: "Rate limit exceeded",
|
|
1907
|
+
solution: "Wait before retrying the operation",
|
|
1908
|
+
},
|
|
1909
|
+
{
|
|
1910
|
+
code: 500,
|
|
1911
|
+
message: "Server error",
|
|
1912
|
+
solution: "Retry operation or contact support",
|
|
1913
|
+
},
|
|
1914
|
+
],
|
|
1915
|
+
conditions: {
|
|
1916
|
+
postconditions: ["Resource updated with new values"],
|
|
1917
|
+
prerequisites: ["Active namespace"],
|
|
1918
|
+
},
|
|
1919
|
+
confirmation_required: false,
|
|
1920
|
+
danger_level: "medium",
|
|
1921
|
+
examples: [
|
|
1922
|
+
{
|
|
1923
|
+
command: "f5xcctl config k8s-cluster-role update {name} --namespace {namespace} -f {file}.yaml",
|
|
1924
|
+
description: "Update k8s-cluster-role",
|
|
1925
|
+
use_case: "update",
|
|
1926
|
+
},
|
|
1927
|
+
],
|
|
1928
|
+
field_docs: {},
|
|
1929
|
+
optional_fields: [],
|
|
1930
|
+
performance_impact: {
|
|
1931
|
+
latency: "low",
|
|
1932
|
+
resource_usage: "low",
|
|
1933
|
+
},
|
|
1934
|
+
purpose: "Replace existing k8s-cluster-role",
|
|
1935
|
+
required_fields: ["path.metadata.name", "path.metadata.namespace"],
|
|
1936
|
+
side_effects: {
|
|
1937
|
+
modifies: ["k8s-cluster-role"],
|
|
1938
|
+
},
|
|
1939
|
+
},
|
|
1940
|
+
},
|
|
1941
|
+
{
|
|
1942
|
+
toolName: "f5xc-api-managedkubernetes-k8s-pod-security-admission-create",
|
|
1943
|
+
method: "POST",
|
|
1944
|
+
path: "/api/config/namespaces/{metadata.namespace}/k8s_pod_security_admissions",
|
|
1945
|
+
operation: "create",
|
|
1946
|
+
domain: "managed_kubernetes",
|
|
1947
|
+
resource: "k8s-pod-security-admission",
|
|
1948
|
+
summary: "Create Configuration Specification.",
|
|
1949
|
+
description: "Create k8s_pod_security_admission will create the object in the storage backend.",
|
|
1950
|
+
pathParameters: [
|
|
1951
|
+
{
|
|
1952
|
+
description: 'Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be ""',
|
|
1953
|
+
in: "path",
|
|
1954
|
+
name: "metadata.namespace",
|
|
1955
|
+
required: true,
|
|
1956
|
+
schema: {
|
|
1957
|
+
type: "string",
|
|
1958
|
+
},
|
|
1959
|
+
"x-displayname": "Namespace",
|
|
1960
|
+
"x-ves-example": "Staging",
|
|
1961
|
+
},
|
|
1962
|
+
],
|
|
1963
|
+
queryParameters: [],
|
|
1964
|
+
requestBodySchema: {
|
|
1965
|
+
$ref: "#/components/schemas/k8s_pod_security_admissionCreateRequest",
|
|
1966
|
+
},
|
|
1967
|
+
responseSchema: {
|
|
1968
|
+
$ref: "#/components/schemas/k8s_pod_security_admissionCreateResponse",
|
|
1969
|
+
},
|
|
1970
|
+
requiredParams: ["body", "metadata.namespace"],
|
|
1971
|
+
operationId: "ves.io.schema.k8s_pod_security_admission.API.Create",
|
|
1972
|
+
tags: ["Other"],
|
|
1973
|
+
sourceFile: "domains/managed_kubernetes.json",
|
|
1974
|
+
displayName: null,
|
|
1975
|
+
dangerLevel: "medium",
|
|
1976
|
+
sideEffects: {
|
|
1977
|
+
creates: ["k8s-pod-security-admission"],
|
|
1978
|
+
},
|
|
1979
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
1980
|
+
cliExamples: [
|
|
1981
|
+
{
|
|
1982
|
+
command: "f5xcctl config k8s-pod-security-admission create -f {file}.yaml",
|
|
1983
|
+
description: "Create from YAML file",
|
|
1984
|
+
use_case: "file_based",
|
|
1985
|
+
},
|
|
1986
|
+
{
|
|
1987
|
+
command: "f5xcctl config k8s-pod-security-admission create {name} --namespace {namespace}",
|
|
1988
|
+
description: "Create k8s-pod-security-admission",
|
|
1989
|
+
use_case: "basic_create",
|
|
1990
|
+
},
|
|
1991
|
+
],
|
|
1992
|
+
confirmationRequired: false,
|
|
1993
|
+
parameterExamples: {
|
|
1994
|
+
"metadata.namespace": "Staging",
|
|
1995
|
+
},
|
|
1996
|
+
validationRules: {},
|
|
1997
|
+
operationMetadata: {
|
|
1998
|
+
common_errors: [
|
|
1999
|
+
{
|
|
2000
|
+
code: 401,
|
|
2001
|
+
message: "Authentication required",
|
|
2002
|
+
solution: "Provide valid API credentials",
|
|
2003
|
+
},
|
|
2004
|
+
{
|
|
2005
|
+
code: 403,
|
|
2006
|
+
message: "Permission denied",
|
|
2007
|
+
solution: "Check access permissions for this operation",
|
|
2008
|
+
},
|
|
2009
|
+
{
|
|
2010
|
+
code: 404,
|
|
2011
|
+
message: "Resource not found",
|
|
2012
|
+
solution: "Verify resource name, namespace, and path",
|
|
2013
|
+
},
|
|
2014
|
+
{
|
|
2015
|
+
code: 409,
|
|
2016
|
+
message: "Resource already exists",
|
|
2017
|
+
solution: "Use different name or update existing resource",
|
|
2018
|
+
},
|
|
2019
|
+
{
|
|
2020
|
+
code: 429,
|
|
2021
|
+
message: "Rate limit exceeded",
|
|
2022
|
+
solution: "Wait before retrying the operation",
|
|
2023
|
+
},
|
|
2024
|
+
{
|
|
2025
|
+
code: 500,
|
|
2026
|
+
message: "Server error",
|
|
2027
|
+
solution: "Retry operation or contact support",
|
|
2028
|
+
},
|
|
2029
|
+
],
|
|
2030
|
+
conditions: {
|
|
2031
|
+
postconditions: [
|
|
2032
|
+
"K8s-pod-security-admission resource created",
|
|
2033
|
+
"Resource assigned unique identifier",
|
|
2034
|
+
],
|
|
2035
|
+
prerequisites: ["Active namespace"],
|
|
2036
|
+
},
|
|
2037
|
+
confirmation_required: false,
|
|
2038
|
+
danger_level: "medium",
|
|
2039
|
+
examples: [
|
|
2040
|
+
{
|
|
2041
|
+
command: "f5xcctl config k8s-pod-security-admission create {name} --namespace {namespace}",
|
|
2042
|
+
description: "Create k8s-pod-security-admission",
|
|
2043
|
+
use_case: "basic_create",
|
|
2044
|
+
},
|
|
2045
|
+
{
|
|
2046
|
+
command: "f5xcctl config k8s-pod-security-admission create -f {file}.yaml",
|
|
2047
|
+
description: "Create from YAML file",
|
|
2048
|
+
use_case: "file_based",
|
|
2049
|
+
},
|
|
2050
|
+
],
|
|
2051
|
+
field_docs: {},
|
|
2052
|
+
optional_fields: [],
|
|
2053
|
+
performance_impact: {
|
|
2054
|
+
latency: "low",
|
|
2055
|
+
resource_usage: "low",
|
|
2056
|
+
},
|
|
2057
|
+
purpose: "Create new k8s-pod-security-admission",
|
|
2058
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
2059
|
+
side_effects: {
|
|
2060
|
+
creates: ["k8s-pod-security-admission"],
|
|
2061
|
+
},
|
|
2062
|
+
},
|
|
2063
|
+
},
|
|
2064
|
+
{
|
|
2065
|
+
toolName: "f5xc-api-managedkubernetes-k8s-pod-security-admission-delete",
|
|
2066
|
+
method: "DELETE",
|
|
2067
|
+
path: "/api/config/namespaces/{namespace}/k8s_pod_security_admissions/{name}",
|
|
2068
|
+
operation: "delete",
|
|
2069
|
+
domain: "managed_kubernetes",
|
|
2070
|
+
resource: "k8s-pod-security-admission",
|
|
2071
|
+
summary: "DELETE K8s Pod Security Admission.",
|
|
2072
|
+
description: "DELETE the specified k8s_pod_security_admission.",
|
|
2073
|
+
pathParameters: [
|
|
2074
|
+
{
|
|
2075
|
+
description: "Name\nName of the configuration object.",
|
|
2076
|
+
in: "path",
|
|
2077
|
+
name: "name",
|
|
2078
|
+
required: true,
|
|
2079
|
+
schema: {
|
|
2080
|
+
type: "string",
|
|
2081
|
+
},
|
|
2082
|
+
"x-displayname": "Name",
|
|
2083
|
+
"x-ves-example": "Name",
|
|
2084
|
+
},
|
|
2085
|
+
{
|
|
2086
|
+
description: "Namespace\nNamespace in which the configuration object is present.",
|
|
2087
|
+
in: "path",
|
|
2088
|
+
name: "namespace",
|
|
2089
|
+
required: true,
|
|
2090
|
+
schema: {
|
|
2091
|
+
type: "string",
|
|
2092
|
+
},
|
|
2093
|
+
"x-displayname": "Namespace",
|
|
2094
|
+
"x-ves-example": "Ns1",
|
|
2095
|
+
},
|
|
2096
|
+
],
|
|
2097
|
+
queryParameters: [],
|
|
2098
|
+
requestBodySchema: {
|
|
2099
|
+
$ref: "#/components/schemas/k8s_pod_security_admissionDeleteRequest",
|
|
2100
|
+
},
|
|
2101
|
+
responseSchema: {},
|
|
2102
|
+
requiredParams: ["body", "name", "namespace"],
|
|
2103
|
+
operationId: "ves.io.schema.k8s_pod_security_admission.API.Delete",
|
|
2104
|
+
tags: ["Other"],
|
|
2105
|
+
sourceFile: "domains/managed_kubernetes.json",
|
|
2106
|
+
displayName: null,
|
|
2107
|
+
dangerLevel: "high",
|
|
2108
|
+
sideEffects: {
|
|
2109
|
+
deletes: ["k8s-pod-security-admission", "contained_resources"],
|
|
2110
|
+
},
|
|
2111
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
2112
|
+
cliExamples: [
|
|
2113
|
+
{
|
|
2114
|
+
command: "f5xcctl config k8s-pod-security-admission delete {name} --namespace {namespace}",
|
|
2115
|
+
description: "Delete k8s-pod-security-admission",
|
|
2116
|
+
use_case: "delete",
|
|
2117
|
+
},
|
|
2118
|
+
],
|
|
2119
|
+
confirmationRequired: true,
|
|
2120
|
+
parameterExamples: {
|
|
2121
|
+
name: "Name",
|
|
2122
|
+
namespace: "Ns1",
|
|
2123
|
+
},
|
|
2124
|
+
validationRules: {},
|
|
2125
|
+
operationMetadata: {
|
|
2126
|
+
common_errors: [
|
|
2127
|
+
{
|
|
2128
|
+
code: 401,
|
|
2129
|
+
message: "Authentication required",
|
|
2130
|
+
solution: "Provide valid API credentials",
|
|
2131
|
+
},
|
|
2132
|
+
{
|
|
2133
|
+
code: 403,
|
|
2134
|
+
message: "Permission denied",
|
|
2135
|
+
solution: "Check access permissions for this operation",
|
|
2136
|
+
},
|
|
2137
|
+
{
|
|
2138
|
+
code: 404,
|
|
2139
|
+
message: "Resource not found",
|
|
2140
|
+
solution: "Verify resource name, namespace, and path",
|
|
2141
|
+
},
|
|
2142
|
+
{
|
|
2143
|
+
code: 409,
|
|
2144
|
+
message: "Resource already exists",
|
|
2145
|
+
solution: "Use different name or update existing resource",
|
|
2146
|
+
},
|
|
2147
|
+
{
|
|
2148
|
+
code: 429,
|
|
2149
|
+
message: "Rate limit exceeded",
|
|
2150
|
+
solution: "Wait before retrying the operation",
|
|
2151
|
+
},
|
|
2152
|
+
{
|
|
2153
|
+
code: 500,
|
|
2154
|
+
message: "Server error",
|
|
2155
|
+
solution: "Retry operation or contact support",
|
|
2156
|
+
},
|
|
2157
|
+
],
|
|
2158
|
+
conditions: {
|
|
2159
|
+
postconditions: ["Resource removed from system", "Associated resources may be affected"],
|
|
2160
|
+
prerequisites: ["Active namespace"],
|
|
2161
|
+
},
|
|
2162
|
+
confirmation_required: true,
|
|
2163
|
+
danger_level: "high",
|
|
2164
|
+
examples: [
|
|
2165
|
+
{
|
|
2166
|
+
command: "f5xcctl config k8s-pod-security-admission delete {name} --namespace {namespace}",
|
|
2167
|
+
description: "Delete k8s-pod-security-admission",
|
|
2168
|
+
use_case: "delete",
|
|
2169
|
+
},
|
|
2170
|
+
],
|
|
2171
|
+
field_docs: {},
|
|
2172
|
+
optional_fields: [],
|
|
2173
|
+
performance_impact: {
|
|
2174
|
+
latency: "high",
|
|
2175
|
+
resource_usage: "moderate",
|
|
2176
|
+
},
|
|
2177
|
+
purpose: "Delete k8s-pod-security-admission",
|
|
2178
|
+
required_fields: ["path.name", "path.namespace"],
|
|
2179
|
+
side_effects: {
|
|
2180
|
+
deletes: ["k8s-pod-security-admission", "contained_resources"],
|
|
2181
|
+
},
|
|
2182
|
+
},
|
|
2183
|
+
},
|
|
2184
|
+
{
|
|
2185
|
+
toolName: "f5xc-api-managedkubernetes-k8s-pod-security-admission-get",
|
|
2186
|
+
method: "GET",
|
|
2187
|
+
path: "/api/config/namespaces/{namespace}/k8s_pod_security_admissions/{name}",
|
|
2188
|
+
operation: "get",
|
|
2189
|
+
domain: "managed_kubernetes",
|
|
2190
|
+
resource: "k8s-pod-security-admission",
|
|
2191
|
+
summary: "GET Configuration Specification.",
|
|
2192
|
+
description: "GET k8s_pod_security_admission will GET the object from the storage backend.",
|
|
2193
|
+
pathParameters: [
|
|
2194
|
+
{
|
|
2195
|
+
description: "Name\nThe name of the configuration object to be fetched.",
|
|
2196
|
+
in: "path",
|
|
2197
|
+
name: "name",
|
|
2198
|
+
required: true,
|
|
2199
|
+
schema: {
|
|
2200
|
+
type: "string",
|
|
2201
|
+
},
|
|
2202
|
+
"x-displayname": "Name",
|
|
2203
|
+
"x-ves-example": "Name",
|
|
2204
|
+
},
|
|
2205
|
+
{
|
|
2206
|
+
description: "Namespace\nThe namespace in which the configuration object is present.",
|
|
2207
|
+
in: "path",
|
|
2208
|
+
name: "namespace",
|
|
2209
|
+
required: true,
|
|
2210
|
+
schema: {
|
|
2211
|
+
type: "string",
|
|
2212
|
+
},
|
|
2213
|
+
"x-displayname": "Namespace",
|
|
2214
|
+
"x-ves-example": "Ns1",
|
|
2215
|
+
},
|
|
2216
|
+
],
|
|
2217
|
+
queryParameters: [
|
|
2218
|
+
{
|
|
2219
|
+
description: "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referrred by this object.",
|
|
2220
|
+
in: "query",
|
|
2221
|
+
name: "response_format",
|
|
2222
|
+
required: false,
|
|
2223
|
+
schema: {
|
|
2224
|
+
default: "GET_RSP_FORMAT_DEFAULT",
|
|
2225
|
+
enum: [
|
|
2226
|
+
"GET_RSP_FORMAT_DEFAULT",
|
|
2227
|
+
"GET_RSP_FORMAT_FOR_CREATE",
|
|
2228
|
+
"GET_RSP_FORMAT_FOR_REPLACE",
|
|
2229
|
+
"GET_RSP_FORMAT_STATUS",
|
|
2230
|
+
"GET_RSP_FORMAT_READ",
|
|
2231
|
+
"GET_RSP_FORMAT_REFERRING_OBJECTS",
|
|
2232
|
+
"GET_RSP_FORMAT_BROKEN_REFERENCES",
|
|
2233
|
+
],
|
|
2234
|
+
type: "string",
|
|
2235
|
+
},
|
|
2236
|
+
"x-displayname": "Broken Referred Objects.",
|
|
2237
|
+
},
|
|
2238
|
+
],
|
|
2239
|
+
requestBodySchema: null,
|
|
2240
|
+
responseSchema: {
|
|
2241
|
+
$ref: "#/components/schemas/k8s_pod_security_admissionGetResponse",
|
|
2242
|
+
},
|
|
2243
|
+
requiredParams: ["name", "namespace"],
|
|
2244
|
+
operationId: "ves.io.schema.k8s_pod_security_admission.API.Get",
|
|
2245
|
+
tags: ["Other"],
|
|
2246
|
+
sourceFile: "domains/managed_kubernetes.json",
|
|
2247
|
+
displayName: null,
|
|
2248
|
+
dangerLevel: "low",
|
|
2249
|
+
sideEffects: null,
|
|
2250
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
2251
|
+
cliExamples: [
|
|
2252
|
+
{
|
|
2253
|
+
command: "f5xcctl config k8s-pod-security-admission get {name} --namespace {namespace}",
|
|
2254
|
+
description: "Get specific k8s-pod-security-admission",
|
|
2255
|
+
use_case: "get_specific",
|
|
2256
|
+
},
|
|
2257
|
+
],
|
|
2258
|
+
confirmationRequired: false,
|
|
2259
|
+
parameterExamples: {
|
|
2260
|
+
name: "Name",
|
|
2261
|
+
namespace: "Ns1",
|
|
2262
|
+
},
|
|
2263
|
+
validationRules: {},
|
|
2264
|
+
operationMetadata: {
|
|
2265
|
+
common_errors: [
|
|
2266
|
+
{
|
|
2267
|
+
code: 401,
|
|
2268
|
+
message: "Authentication required",
|
|
2269
|
+
solution: "Provide valid API credentials",
|
|
2270
|
+
},
|
|
2271
|
+
{
|
|
2272
|
+
code: 403,
|
|
2273
|
+
message: "Permission denied",
|
|
2274
|
+
solution: "Check access permissions for this operation",
|
|
2275
|
+
},
|
|
2276
|
+
{
|
|
2277
|
+
code: 404,
|
|
2278
|
+
message: "Resource not found",
|
|
2279
|
+
solution: "Verify resource name, namespace, and path",
|
|
2280
|
+
},
|
|
2281
|
+
{
|
|
2282
|
+
code: 409,
|
|
2283
|
+
message: "Resource already exists",
|
|
2284
|
+
solution: "Use different name or update existing resource",
|
|
2285
|
+
},
|
|
2286
|
+
{
|
|
2287
|
+
code: 429,
|
|
2288
|
+
message: "Rate limit exceeded",
|
|
2289
|
+
solution: "Wait before retrying the operation",
|
|
2290
|
+
},
|
|
2291
|
+
{
|
|
2292
|
+
code: 500,
|
|
2293
|
+
message: "Server error",
|
|
2294
|
+
solution: "Retry operation or contact support",
|
|
2295
|
+
},
|
|
2296
|
+
],
|
|
2297
|
+
conditions: {
|
|
2298
|
+
postconditions: [],
|
|
2299
|
+
prerequisites: ["Active namespace"],
|
|
2300
|
+
},
|
|
2301
|
+
confirmation_required: false,
|
|
2302
|
+
danger_level: "low",
|
|
2303
|
+
examples: [
|
|
2304
|
+
{
|
|
2305
|
+
command: "f5xcctl config k8s-pod-security-admission get {name} --namespace {namespace}",
|
|
2306
|
+
description: "Get specific k8s-pod-security-admission",
|
|
2307
|
+
use_case: "get_specific",
|
|
2308
|
+
},
|
|
2309
|
+
],
|
|
2310
|
+
field_docs: {},
|
|
2311
|
+
optional_fields: [],
|
|
2312
|
+
performance_impact: {
|
|
2313
|
+
latency: "low",
|
|
2314
|
+
resource_usage: "low",
|
|
2315
|
+
},
|
|
2316
|
+
purpose: "Retrieve specific k8s-pod-security-admission",
|
|
2317
|
+
required_fields: ["path.name", "path.namespace"],
|
|
2318
|
+
side_effects: {},
|
|
2319
|
+
},
|
|
2320
|
+
},
|
|
2321
|
+
{
|
|
2322
|
+
toolName: "f5xc-api-managedkubernetes-k8s-pod-security-admission-list",
|
|
2323
|
+
method: "GET",
|
|
2324
|
+
path: "/api/config/namespaces/{namespace}/k8s_pod_security_admissions",
|
|
2325
|
+
operation: "list",
|
|
2326
|
+
domain: "managed_kubernetes",
|
|
2327
|
+
resource: "k8s-pod-security-admission",
|
|
2328
|
+
summary: "List K8s Pod Security Admission.",
|
|
2329
|
+
description: "List the set of k8s_pod_security_admission in a namespace.",
|
|
2330
|
+
pathParameters: [
|
|
2331
|
+
{
|
|
2332
|
+
description: "Namespace\nNamespace to scope the listing of k8s_pod_security_admission.",
|
|
2333
|
+
in: "path",
|
|
2334
|
+
name: "namespace",
|
|
2335
|
+
required: true,
|
|
2336
|
+
schema: {
|
|
2337
|
+
type: "string",
|
|
2338
|
+
},
|
|
2339
|
+
"x-displayname": "Namespace",
|
|
2340
|
+
"x-ves-example": "Ns1",
|
|
2341
|
+
},
|
|
2342
|
+
],
|
|
2343
|
+
queryParameters: [
|
|
2344
|
+
{
|
|
2345
|
+
description: "A LabelSelectorType expression that every item in list response will satisfy.",
|
|
2346
|
+
in: "query",
|
|
2347
|
+
name: "label_filter",
|
|
2348
|
+
required: false,
|
|
2349
|
+
schema: {
|
|
2350
|
+
type: "string",
|
|
2351
|
+
},
|
|
2352
|
+
"x-displayname": "Label Filter.",
|
|
2353
|
+
"x-ves-example": "Env in (staging, testing), tier in (web, db)",
|
|
2354
|
+
},
|
|
2355
|
+
{
|
|
2356
|
+
description: 'X-example: ""\nExtra fields to return along with summary fields.',
|
|
2357
|
+
in: "query",
|
|
2358
|
+
name: "report_fields",
|
|
2359
|
+
required: false,
|
|
2360
|
+
schema: {
|
|
2361
|
+
items: {
|
|
2362
|
+
type: "string",
|
|
2363
|
+
},
|
|
2364
|
+
type: "array",
|
|
2365
|
+
},
|
|
2366
|
+
"x-displayname": "Report Fields.",
|
|
2367
|
+
},
|
|
2368
|
+
{
|
|
2369
|
+
description: 'X-example: ""\nExtra status fields to return along with summary fields.',
|
|
2370
|
+
in: "query",
|
|
2371
|
+
name: "report_status_fields",
|
|
2372
|
+
required: false,
|
|
2373
|
+
schema: {
|
|
2374
|
+
items: {
|
|
2375
|
+
type: "string",
|
|
2376
|
+
},
|
|
2377
|
+
type: "array",
|
|
2378
|
+
},
|
|
2379
|
+
"x-displayname": "Report Status Fields.",
|
|
2380
|
+
},
|
|
2381
|
+
],
|
|
2382
|
+
requestBodySchema: null,
|
|
2383
|
+
responseSchema: {
|
|
2384
|
+
$ref: "#/components/schemas/k8s_pod_security_admissionListResponse",
|
|
2385
|
+
},
|
|
2386
|
+
requiredParams: ["namespace"],
|
|
2387
|
+
operationId: "ves.io.schema.k8s_pod_security_admission.API.List",
|
|
2388
|
+
tags: ["Other"],
|
|
2389
|
+
sourceFile: "domains/managed_kubernetes.json",
|
|
2390
|
+
displayName: null,
|
|
2391
|
+
dangerLevel: "low",
|
|
2392
|
+
sideEffects: null,
|
|
2393
|
+
requiredFields: ["path.namespace"],
|
|
2394
|
+
cliExamples: [
|
|
2395
|
+
{
|
|
2396
|
+
command: "f5xcctl config k8s-pod-security-admission list --namespace {namespace}",
|
|
2397
|
+
description: "List all k8s-pod-security-admissions",
|
|
2398
|
+
use_case: "list_all",
|
|
2399
|
+
},
|
|
2400
|
+
],
|
|
2401
|
+
confirmationRequired: false,
|
|
2402
|
+
parameterExamples: {
|
|
2403
|
+
label_filter: "Env in (staging, testing), tier in (web, db)",
|
|
2404
|
+
namespace: "Ns1",
|
|
2405
|
+
},
|
|
2406
|
+
validationRules: {},
|
|
2407
|
+
operationMetadata: {
|
|
2408
|
+
common_errors: [
|
|
2409
|
+
{
|
|
2410
|
+
code: 401,
|
|
2411
|
+
message: "Authentication required",
|
|
2412
|
+
solution: "Provide valid API credentials",
|
|
2413
|
+
},
|
|
2414
|
+
{
|
|
2415
|
+
code: 403,
|
|
2416
|
+
message: "Permission denied",
|
|
2417
|
+
solution: "Check access permissions for this operation",
|
|
2418
|
+
},
|
|
2419
|
+
{
|
|
2420
|
+
code: 404,
|
|
2421
|
+
message: "Resource not found",
|
|
2422
|
+
solution: "Verify resource name, namespace, and path",
|
|
2423
|
+
},
|
|
2424
|
+
{
|
|
2425
|
+
code: 409,
|
|
2426
|
+
message: "Resource already exists",
|
|
2427
|
+
solution: "Use different name or update existing resource",
|
|
2428
|
+
},
|
|
2429
|
+
{
|
|
2430
|
+
code: 429,
|
|
2431
|
+
message: "Rate limit exceeded",
|
|
2432
|
+
solution: "Wait before retrying the operation",
|
|
2433
|
+
},
|
|
2434
|
+
{
|
|
2435
|
+
code: 500,
|
|
2436
|
+
message: "Server error",
|
|
2437
|
+
solution: "Retry operation or contact support",
|
|
2438
|
+
},
|
|
2439
|
+
],
|
|
2440
|
+
conditions: {
|
|
2441
|
+
postconditions: [],
|
|
2442
|
+
prerequisites: ["Active namespace"],
|
|
2443
|
+
},
|
|
2444
|
+
confirmation_required: false,
|
|
2445
|
+
danger_level: "low",
|
|
2446
|
+
examples: [
|
|
2447
|
+
{
|
|
2448
|
+
command: "f5xcctl config k8s-pod-security-admission list --namespace {namespace}",
|
|
2449
|
+
description: "List all k8s-pod-security-admissions",
|
|
2450
|
+
use_case: "list_all",
|
|
2451
|
+
},
|
|
2452
|
+
],
|
|
2453
|
+
field_docs: {},
|
|
2454
|
+
optional_fields: [],
|
|
2455
|
+
performance_impact: {
|
|
2456
|
+
latency: "moderate",
|
|
2457
|
+
resource_usage: "moderate",
|
|
2458
|
+
},
|
|
2459
|
+
purpose: "List all k8s-pod-security-admissions",
|
|
2460
|
+
required_fields: ["path.namespace"],
|
|
2461
|
+
side_effects: {},
|
|
2462
|
+
},
|
|
2463
|
+
},
|
|
2464
|
+
{
|
|
2465
|
+
toolName: "f5xc-api-managedkubernetes-k8s-pod-security-admission-update",
|
|
2466
|
+
method: "PUT",
|
|
2467
|
+
path: "/api/config/namespaces/{metadata.namespace}/k8s_pod_security_admissions/{metadata.name}",
|
|
2468
|
+
operation: "update",
|
|
2469
|
+
domain: "managed_kubernetes",
|
|
2470
|
+
resource: "k8s-pod-security-admission",
|
|
2471
|
+
summary: "Replace Configuration Specification.",
|
|
2472
|
+
description: "Replacing an k8s_pod_security_admission object will update the object by replacing the existing spec with the provided one.\nFor read-then-write operations a resourceVersion mismatch will occur if the object was modified between the read and write.",
|
|
2473
|
+
pathParameters: [
|
|
2474
|
+
{
|
|
2475
|
+
description: "Name\nThe configuration object to be replaced will be looked up by name.",
|
|
2476
|
+
in: "path",
|
|
2477
|
+
name: "metadata.name",
|
|
2478
|
+
required: true,
|
|
2479
|
+
schema: {
|
|
2480
|
+
type: "string",
|
|
2481
|
+
},
|
|
2482
|
+
"x-displayname": "Name",
|
|
2483
|
+
"x-ves-example": "Example-corp-web.",
|
|
2484
|
+
},
|
|
2485
|
+
{
|
|
2486
|
+
description: 'Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be ""',
|
|
2487
|
+
in: "path",
|
|
2488
|
+
name: "metadata.namespace",
|
|
2489
|
+
required: true,
|
|
2490
|
+
schema: {
|
|
2491
|
+
type: "string",
|
|
2492
|
+
},
|
|
2493
|
+
"x-displayname": "Namespace",
|
|
2494
|
+
"x-ves-example": "Staging",
|
|
2495
|
+
},
|
|
2496
|
+
],
|
|
2497
|
+
queryParameters: [],
|
|
2498
|
+
requestBodySchema: {
|
|
2499
|
+
$ref: "#/components/schemas/k8s_pod_security_admissionReplaceRequest",
|
|
2500
|
+
},
|
|
2501
|
+
responseSchema: {
|
|
2502
|
+
$ref: "#/components/schemas/k8s_pod_security_admissionReplaceResponse",
|
|
2503
|
+
},
|
|
2504
|
+
requiredParams: ["body", "metadata.name", "metadata.namespace"],
|
|
2505
|
+
operationId: "ves.io.schema.k8s_pod_security_admission.API.Replace",
|
|
2506
|
+
tags: ["Other"],
|
|
2507
|
+
sourceFile: "domains/managed_kubernetes.json",
|
|
2508
|
+
displayName: null,
|
|
2509
|
+
dangerLevel: "medium",
|
|
2510
|
+
sideEffects: {
|
|
2511
|
+
modifies: ["k8s-pod-security-admission"],
|
|
2512
|
+
},
|
|
2513
|
+
requiredFields: ["path.metadata.name", "path.metadata.namespace"],
|
|
2514
|
+
cliExamples: [
|
|
2515
|
+
{
|
|
2516
|
+
command: "f5xcctl config k8s-pod-security-admission update {name} --namespace {namespace} -f {file}.yaml",
|
|
2517
|
+
description: "Update k8s-pod-security-admission",
|
|
2518
|
+
use_case: "update",
|
|
2519
|
+
},
|
|
2520
|
+
],
|
|
2521
|
+
confirmationRequired: false,
|
|
2522
|
+
parameterExamples: {
|
|
2523
|
+
"metadata.name": "Example-corp-web.",
|
|
2524
|
+
"metadata.namespace": "Staging",
|
|
2525
|
+
},
|
|
2526
|
+
validationRules: {},
|
|
2527
|
+
operationMetadata: {
|
|
2528
|
+
common_errors: [
|
|
2529
|
+
{
|
|
2530
|
+
code: 401,
|
|
2531
|
+
message: "Authentication required",
|
|
2532
|
+
solution: "Provide valid API credentials",
|
|
2533
|
+
},
|
|
2534
|
+
{
|
|
2535
|
+
code: 403,
|
|
2536
|
+
message: "Permission denied",
|
|
2537
|
+
solution: "Check access permissions for this operation",
|
|
2538
|
+
},
|
|
2539
|
+
{
|
|
2540
|
+
code: 404,
|
|
2541
|
+
message: "Resource not found",
|
|
2542
|
+
solution: "Verify resource name, namespace, and path",
|
|
2543
|
+
},
|
|
2544
|
+
{
|
|
2545
|
+
code: 409,
|
|
2546
|
+
message: "Resource already exists",
|
|
2547
|
+
solution: "Use different name or update existing resource",
|
|
2548
|
+
},
|
|
2549
|
+
{
|
|
2550
|
+
code: 429,
|
|
2551
|
+
message: "Rate limit exceeded",
|
|
2552
|
+
solution: "Wait before retrying the operation",
|
|
2553
|
+
},
|
|
2554
|
+
{
|
|
2555
|
+
code: 500,
|
|
2556
|
+
message: "Server error",
|
|
2557
|
+
solution: "Retry operation or contact support",
|
|
2558
|
+
},
|
|
2559
|
+
],
|
|
2560
|
+
conditions: {
|
|
2561
|
+
postconditions: ["Resource updated with new values"],
|
|
2562
|
+
prerequisites: ["Active namespace"],
|
|
2563
|
+
},
|
|
2564
|
+
confirmation_required: false,
|
|
2565
|
+
danger_level: "medium",
|
|
2566
|
+
examples: [
|
|
2567
|
+
{
|
|
2568
|
+
command: "f5xcctl config k8s-pod-security-admission update {name} --namespace {namespace} -f {file}.yaml",
|
|
2569
|
+
description: "Update k8s-pod-security-admission",
|
|
2570
|
+
use_case: "update",
|
|
2571
|
+
},
|
|
2572
|
+
],
|
|
2573
|
+
field_docs: {},
|
|
2574
|
+
optional_fields: [],
|
|
2575
|
+
performance_impact: {
|
|
2576
|
+
latency: "low",
|
|
2577
|
+
resource_usage: "low",
|
|
2578
|
+
},
|
|
2579
|
+
purpose: "Replace existing k8s-pod-security-admission",
|
|
2580
|
+
required_fields: ["path.metadata.name", "path.metadata.namespace"],
|
|
2581
|
+
side_effects: {
|
|
2582
|
+
modifies: ["k8s-pod-security-admission"],
|
|
2583
|
+
},
|
|
2584
|
+
},
|
|
2585
|
+
},
|
|
2586
|
+
{
|
|
2587
|
+
toolName: "f5xc-api-managedkubernetes-k8s-pod-security-policy-create",
|
|
2588
|
+
method: "POST",
|
|
2589
|
+
path: "/api/config/namespaces/{metadata.namespace}/k8s_pod_security_policys",
|
|
2590
|
+
operation: "create",
|
|
2591
|
+
domain: "managed_kubernetes",
|
|
2592
|
+
resource: "k8s-pod-security-policy",
|
|
2593
|
+
summary: "Create Configuration Specification.",
|
|
2594
|
+
description: "Create k8s_pod_security_policy will create the object in the storage backend for namespace metadata.namespace.",
|
|
2595
|
+
pathParameters: [
|
|
2596
|
+
{
|
|
2597
|
+
description: 'Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be ""',
|
|
2598
|
+
in: "path",
|
|
2599
|
+
name: "metadata.namespace",
|
|
2600
|
+
required: true,
|
|
2601
|
+
schema: {
|
|
2602
|
+
type: "string",
|
|
2603
|
+
},
|
|
2604
|
+
"x-displayname": "Namespace",
|
|
2605
|
+
"x-ves-example": "Staging",
|
|
2606
|
+
},
|
|
2607
|
+
],
|
|
2608
|
+
queryParameters: [],
|
|
2609
|
+
requestBodySchema: {
|
|
2610
|
+
$ref: "#/components/schemas/k8s_pod_security_policyCreateRequest",
|
|
2611
|
+
},
|
|
2612
|
+
responseSchema: {
|
|
2613
|
+
$ref: "#/components/schemas/k8s_pod_security_policyCreateResponse",
|
|
2614
|
+
},
|
|
2615
|
+
requiredParams: ["body", "metadata.namespace"],
|
|
2616
|
+
operationId: "ves.io.schema.k8s_pod_security_policy.API.Create",
|
|
2617
|
+
tags: ["Other"],
|
|
2618
|
+
sourceFile: "domains/managed_kubernetes.json",
|
|
2619
|
+
displayName: null,
|
|
2620
|
+
dangerLevel: "medium",
|
|
2621
|
+
sideEffects: {
|
|
2622
|
+
creates: ["k8s-pod-security-policy"],
|
|
2623
|
+
},
|
|
2624
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
2625
|
+
cliExamples: [
|
|
2626
|
+
{
|
|
2627
|
+
command: "f5xcctl config k8s-pod-security-policy create -f {file}.yaml",
|
|
2628
|
+
description: "Create from YAML file",
|
|
2629
|
+
use_case: "file_based",
|
|
2630
|
+
},
|
|
2631
|
+
{
|
|
2632
|
+
command: "f5xcctl config k8s-pod-security-policy create {name} --namespace {namespace}",
|
|
2633
|
+
description: "Create k8s-pod-security-policy",
|
|
2634
|
+
use_case: "basic_create",
|
|
2635
|
+
},
|
|
2636
|
+
],
|
|
2637
|
+
confirmationRequired: false,
|
|
2638
|
+
parameterExamples: {
|
|
2639
|
+
"metadata.namespace": "Staging",
|
|
2640
|
+
},
|
|
2641
|
+
validationRules: {},
|
|
2642
|
+
operationMetadata: {
|
|
2643
|
+
common_errors: [
|
|
2644
|
+
{
|
|
2645
|
+
code: 401,
|
|
2646
|
+
message: "Authentication required",
|
|
2647
|
+
solution: "Provide valid API credentials",
|
|
2648
|
+
},
|
|
2649
|
+
{
|
|
2650
|
+
code: 403,
|
|
2651
|
+
message: "Permission denied",
|
|
2652
|
+
solution: "Check access permissions for this operation",
|
|
2653
|
+
},
|
|
2654
|
+
{
|
|
2655
|
+
code: 404,
|
|
2656
|
+
message: "Resource not found",
|
|
2657
|
+
solution: "Verify resource name, namespace, and path",
|
|
2658
|
+
},
|
|
2659
|
+
{
|
|
2660
|
+
code: 409,
|
|
2661
|
+
message: "Resource already exists",
|
|
2662
|
+
solution: "Use different name or update existing resource",
|
|
2663
|
+
},
|
|
2664
|
+
{
|
|
2665
|
+
code: 429,
|
|
2666
|
+
message: "Rate limit exceeded",
|
|
2667
|
+
solution: "Wait before retrying the operation",
|
|
2668
|
+
},
|
|
2669
|
+
{
|
|
2670
|
+
code: 500,
|
|
2671
|
+
message: "Server error",
|
|
2672
|
+
solution: "Retry operation or contact support",
|
|
2673
|
+
},
|
|
2674
|
+
],
|
|
2675
|
+
conditions: {
|
|
2676
|
+
postconditions: [
|
|
2677
|
+
"K8s-pod-security-policy resource created",
|
|
2678
|
+
"Resource assigned unique identifier",
|
|
2679
|
+
],
|
|
2680
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
2681
|
+
},
|
|
2682
|
+
confirmation_required: false,
|
|
2683
|
+
danger_level: "medium",
|
|
2684
|
+
examples: [
|
|
2685
|
+
{
|
|
2686
|
+
command: "f5xcctl config k8s-pod-security-policy create {name} --namespace {namespace}",
|
|
2687
|
+
description: "Create k8s-pod-security-policy",
|
|
2688
|
+
use_case: "basic_create",
|
|
2689
|
+
},
|
|
2690
|
+
{
|
|
2691
|
+
command: "f5xcctl config k8s-pod-security-policy create -f {file}.yaml",
|
|
2692
|
+
description: "Create from YAML file",
|
|
2693
|
+
use_case: "file_based",
|
|
2694
|
+
},
|
|
2695
|
+
],
|
|
2696
|
+
field_docs: {},
|
|
2697
|
+
optional_fields: [],
|
|
2698
|
+
performance_impact: {
|
|
2699
|
+
latency: "low",
|
|
2700
|
+
resource_usage: "low",
|
|
2701
|
+
},
|
|
2702
|
+
purpose: "Create new k8s-pod-security-policy",
|
|
2703
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
2704
|
+
side_effects: {
|
|
2705
|
+
creates: ["k8s-pod-security-policy"],
|
|
2706
|
+
},
|
|
2707
|
+
},
|
|
2708
|
+
},
|
|
2709
|
+
{
|
|
2710
|
+
toolName: "f5xc-api-managedkubernetes-k8s-pod-security-policy-delete",
|
|
2711
|
+
method: "DELETE",
|
|
2712
|
+
path: "/api/config/namespaces/{namespace}/k8s_pod_security_policys/{name}",
|
|
2713
|
+
operation: "delete",
|
|
2714
|
+
domain: "managed_kubernetes",
|
|
2715
|
+
resource: "k8s-pod-security-policy",
|
|
2716
|
+
summary: "DELETE K8s Pod Security Policy.",
|
|
2717
|
+
description: "DELETE the specified k8s_pod_security_policy.",
|
|
2718
|
+
pathParameters: [
|
|
2719
|
+
{
|
|
2720
|
+
description: "Name\nName of the configuration object.",
|
|
2721
|
+
in: "path",
|
|
2722
|
+
name: "name",
|
|
2723
|
+
required: true,
|
|
2724
|
+
schema: {
|
|
2725
|
+
type: "string",
|
|
2726
|
+
},
|
|
2727
|
+
"x-displayname": "Name",
|
|
2728
|
+
"x-ves-example": "Name",
|
|
2729
|
+
},
|
|
2730
|
+
{
|
|
2731
|
+
description: "Namespace\nNamespace in which the configuration object is present.",
|
|
2732
|
+
in: "path",
|
|
2733
|
+
name: "namespace",
|
|
2734
|
+
required: true,
|
|
2735
|
+
schema: {
|
|
2736
|
+
type: "string",
|
|
2737
|
+
},
|
|
2738
|
+
"x-displayname": "Namespace",
|
|
2739
|
+
"x-ves-example": "Ns1",
|
|
2740
|
+
},
|
|
2741
|
+
],
|
|
2742
|
+
queryParameters: [],
|
|
2743
|
+
requestBodySchema: {
|
|
2744
|
+
$ref: "#/components/schemas/k8s_pod_security_policyDeleteRequest",
|
|
2745
|
+
},
|
|
2746
|
+
responseSchema: {},
|
|
2747
|
+
requiredParams: ["body", "name", "namespace"],
|
|
2748
|
+
operationId: "ves.io.schema.k8s_pod_security_policy.API.Delete",
|
|
2749
|
+
tags: ["Other"],
|
|
2750
|
+
sourceFile: "domains/managed_kubernetes.json",
|
|
2751
|
+
displayName: null,
|
|
2752
|
+
dangerLevel: "high",
|
|
2753
|
+
sideEffects: {
|
|
2754
|
+
deletes: ["k8s-pod-security-policy", "contained_resources"],
|
|
2755
|
+
},
|
|
2756
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
2757
|
+
cliExamples: [
|
|
2758
|
+
{
|
|
2759
|
+
command: "f5xcctl config k8s-pod-security-policy delete {name} --namespace {namespace}",
|
|
2760
|
+
description: "Delete k8s-pod-security-policy",
|
|
2761
|
+
use_case: "delete",
|
|
2762
|
+
},
|
|
2763
|
+
],
|
|
2764
|
+
confirmationRequired: true,
|
|
2765
|
+
parameterExamples: {
|
|
2766
|
+
name: "Name",
|
|
2767
|
+
namespace: "Ns1",
|
|
2768
|
+
},
|
|
2769
|
+
validationRules: {},
|
|
2770
|
+
operationMetadata: {
|
|
2771
|
+
common_errors: [
|
|
2772
|
+
{
|
|
2773
|
+
code: 401,
|
|
2774
|
+
message: "Authentication required",
|
|
2775
|
+
solution: "Provide valid API credentials",
|
|
2776
|
+
},
|
|
2777
|
+
{
|
|
2778
|
+
code: 403,
|
|
2779
|
+
message: "Permission denied",
|
|
2780
|
+
solution: "Check access permissions for this operation",
|
|
2781
|
+
},
|
|
2782
|
+
{
|
|
2783
|
+
code: 404,
|
|
2784
|
+
message: "Resource not found",
|
|
2785
|
+
solution: "Verify resource name, namespace, and path",
|
|
2786
|
+
},
|
|
2787
|
+
{
|
|
2788
|
+
code: 409,
|
|
2789
|
+
message: "Resource already exists",
|
|
2790
|
+
solution: "Use different name or update existing resource",
|
|
2791
|
+
},
|
|
2792
|
+
{
|
|
2793
|
+
code: 429,
|
|
2794
|
+
message: "Rate limit exceeded",
|
|
2795
|
+
solution: "Wait before retrying the operation",
|
|
2796
|
+
},
|
|
2797
|
+
{
|
|
2798
|
+
code: 500,
|
|
2799
|
+
message: "Server error",
|
|
2800
|
+
solution: "Retry operation or contact support",
|
|
2801
|
+
},
|
|
2802
|
+
],
|
|
2803
|
+
conditions: {
|
|
2804
|
+
postconditions: ["Resource removed from system", "Associated resources may be affected"],
|
|
2805
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
2806
|
+
},
|
|
2807
|
+
confirmation_required: true,
|
|
2808
|
+
danger_level: "high",
|
|
2809
|
+
examples: [
|
|
2810
|
+
{
|
|
2811
|
+
command: "f5xcctl config k8s-pod-security-policy delete {name} --namespace {namespace}",
|
|
2812
|
+
description: "Delete k8s-pod-security-policy",
|
|
2813
|
+
use_case: "delete",
|
|
2814
|
+
},
|
|
2815
|
+
],
|
|
2816
|
+
field_docs: {},
|
|
2817
|
+
optional_fields: [],
|
|
2818
|
+
performance_impact: {
|
|
2819
|
+
latency: "high",
|
|
2820
|
+
resource_usage: "moderate",
|
|
2821
|
+
},
|
|
2822
|
+
purpose: "Delete k8s-pod-security-policy",
|
|
2823
|
+
required_fields: ["path.name", "path.namespace"],
|
|
2824
|
+
side_effects: {
|
|
2825
|
+
deletes: ["k8s-pod-security-policy", "contained_resources"],
|
|
2826
|
+
},
|
|
2827
|
+
},
|
|
2828
|
+
},
|
|
2829
|
+
{
|
|
2830
|
+
toolName: "f5xc-api-managedkubernetes-k8s-pod-security-policy-get",
|
|
2831
|
+
method: "GET",
|
|
2832
|
+
path: "/api/config/namespaces/{namespace}/k8s_pod_security_policys/{name}",
|
|
2833
|
+
operation: "get",
|
|
2834
|
+
domain: "managed_kubernetes",
|
|
2835
|
+
resource: "k8s-pod-security-policy",
|
|
2836
|
+
summary: "GET Configuration Specification.",
|
|
2837
|
+
description: "GET k8s_pod_security_policy will GET the object from the storage backend for namespace metadata.namespace.",
|
|
2838
|
+
pathParameters: [
|
|
2839
|
+
{
|
|
2840
|
+
description: "Name\nThe name of the configuration object to be fetched.",
|
|
2841
|
+
in: "path",
|
|
2842
|
+
name: "name",
|
|
2843
|
+
required: true,
|
|
2844
|
+
schema: {
|
|
2845
|
+
type: "string",
|
|
2846
|
+
},
|
|
2847
|
+
"x-displayname": "Name",
|
|
2848
|
+
"x-ves-example": "Name",
|
|
2849
|
+
},
|
|
2850
|
+
{
|
|
2851
|
+
description: "Namespace\nThe namespace in which the configuration object is present.",
|
|
2852
|
+
in: "path",
|
|
2853
|
+
name: "namespace",
|
|
2854
|
+
required: true,
|
|
2855
|
+
schema: {
|
|
2856
|
+
type: "string",
|
|
2857
|
+
},
|
|
2858
|
+
"x-displayname": "Namespace",
|
|
2859
|
+
"x-ves-example": "Ns1",
|
|
2860
|
+
},
|
|
2861
|
+
],
|
|
2862
|
+
queryParameters: [
|
|
2863
|
+
{
|
|
2864
|
+
description: "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referrred by this object.",
|
|
2865
|
+
in: "query",
|
|
2866
|
+
name: "response_format",
|
|
2867
|
+
required: false,
|
|
2868
|
+
schema: {
|
|
2869
|
+
default: "GET_RSP_FORMAT_DEFAULT",
|
|
2870
|
+
enum: [
|
|
2871
|
+
"GET_RSP_FORMAT_DEFAULT",
|
|
2872
|
+
"GET_RSP_FORMAT_FOR_CREATE",
|
|
2873
|
+
"GET_RSP_FORMAT_FOR_REPLACE",
|
|
2874
|
+
"GET_RSP_FORMAT_STATUS",
|
|
2875
|
+
"GET_RSP_FORMAT_READ",
|
|
2876
|
+
"GET_RSP_FORMAT_REFERRING_OBJECTS",
|
|
2877
|
+
"GET_RSP_FORMAT_BROKEN_REFERENCES",
|
|
2878
|
+
],
|
|
2879
|
+
type: "string",
|
|
2880
|
+
},
|
|
2881
|
+
"x-displayname": "Broken Referred Objects.",
|
|
2882
|
+
},
|
|
2883
|
+
],
|
|
2884
|
+
requestBodySchema: null,
|
|
2885
|
+
responseSchema: {
|
|
2886
|
+
$ref: "#/components/schemas/k8s_pod_security_policyGetResponse",
|
|
2887
|
+
},
|
|
2888
|
+
requiredParams: ["name", "namespace"],
|
|
2889
|
+
operationId: "ves.io.schema.k8s_pod_security_policy.API.Get",
|
|
2890
|
+
tags: ["Other"],
|
|
2891
|
+
sourceFile: "domains/managed_kubernetes.json",
|
|
2892
|
+
displayName: null,
|
|
2893
|
+
dangerLevel: "low",
|
|
2894
|
+
sideEffects: null,
|
|
2895
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
2896
|
+
cliExamples: [
|
|
2897
|
+
{
|
|
2898
|
+
command: "f5xcctl config k8s-pod-security-policy get {name} --namespace {namespace}",
|
|
2899
|
+
description: "Get specific k8s-pod-security-policy",
|
|
2900
|
+
use_case: "get_specific",
|
|
2901
|
+
},
|
|
2902
|
+
],
|
|
2903
|
+
confirmationRequired: false,
|
|
2904
|
+
parameterExamples: {
|
|
2905
|
+
name: "Name",
|
|
2906
|
+
namespace: "Ns1",
|
|
2907
|
+
},
|
|
2908
|
+
validationRules: {},
|
|
2909
|
+
operationMetadata: {
|
|
2910
|
+
common_errors: [
|
|
2911
|
+
{
|
|
2912
|
+
code: 401,
|
|
2913
|
+
message: "Authentication required",
|
|
2914
|
+
solution: "Provide valid API credentials",
|
|
2915
|
+
},
|
|
2916
|
+
{
|
|
2917
|
+
code: 403,
|
|
2918
|
+
message: "Permission denied",
|
|
2919
|
+
solution: "Check access permissions for this operation",
|
|
2920
|
+
},
|
|
2921
|
+
{
|
|
2922
|
+
code: 404,
|
|
2923
|
+
message: "Resource not found",
|
|
2924
|
+
solution: "Verify resource name, namespace, and path",
|
|
2925
|
+
},
|
|
2926
|
+
{
|
|
2927
|
+
code: 409,
|
|
2928
|
+
message: "Resource already exists",
|
|
2929
|
+
solution: "Use different name or update existing resource",
|
|
2930
|
+
},
|
|
2931
|
+
{
|
|
2932
|
+
code: 429,
|
|
2933
|
+
message: "Rate limit exceeded",
|
|
2934
|
+
solution: "Wait before retrying the operation",
|
|
2935
|
+
},
|
|
2936
|
+
{
|
|
2937
|
+
code: 500,
|
|
2938
|
+
message: "Server error",
|
|
2939
|
+
solution: "Retry operation or contact support",
|
|
2940
|
+
},
|
|
2941
|
+
],
|
|
2942
|
+
conditions: {
|
|
2943
|
+
postconditions: [],
|
|
2944
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
2945
|
+
},
|
|
2946
|
+
confirmation_required: false,
|
|
2947
|
+
danger_level: "low",
|
|
2948
|
+
examples: [
|
|
2949
|
+
{
|
|
2950
|
+
command: "f5xcctl config k8s-pod-security-policy get {name} --namespace {namespace}",
|
|
2951
|
+
description: "Get specific k8s-pod-security-policy",
|
|
2952
|
+
use_case: "get_specific",
|
|
2953
|
+
},
|
|
2954
|
+
],
|
|
2955
|
+
field_docs: {},
|
|
2956
|
+
optional_fields: [],
|
|
2957
|
+
performance_impact: {
|
|
2958
|
+
latency: "low",
|
|
2959
|
+
resource_usage: "low",
|
|
2960
|
+
},
|
|
2961
|
+
purpose: "Retrieve specific k8s-pod-security-policy",
|
|
2962
|
+
required_fields: ["path.name", "path.namespace"],
|
|
2963
|
+
side_effects: {},
|
|
2964
|
+
},
|
|
2965
|
+
},
|
|
2966
|
+
{
|
|
2967
|
+
toolName: "f5xc-api-managedkubernetes-k8s-pod-security-policy-list",
|
|
2968
|
+
method: "GET",
|
|
2969
|
+
path: "/api/config/namespaces/{namespace}/k8s_pod_security_policys",
|
|
2970
|
+
operation: "list",
|
|
2971
|
+
domain: "managed_kubernetes",
|
|
2972
|
+
resource: "k8s-pod-security-policy",
|
|
2973
|
+
summary: "List K8s Pod Security Policy.",
|
|
2974
|
+
description: "List the set of k8s_pod_security_policy in a namespace.",
|
|
2975
|
+
pathParameters: [
|
|
2976
|
+
{
|
|
2977
|
+
description: "Namespace\nNamespace to scope the listing of k8s_pod_security_policy.",
|
|
2978
|
+
in: "path",
|
|
2979
|
+
name: "namespace",
|
|
2980
|
+
required: true,
|
|
2981
|
+
schema: {
|
|
2982
|
+
type: "string",
|
|
2983
|
+
},
|
|
2984
|
+
"x-displayname": "Namespace",
|
|
2985
|
+
"x-ves-example": "Ns1",
|
|
2986
|
+
},
|
|
2987
|
+
],
|
|
2988
|
+
queryParameters: [
|
|
2989
|
+
{
|
|
2990
|
+
description: "A LabelSelectorType expression that every item in list response will satisfy.",
|
|
2991
|
+
in: "query",
|
|
2992
|
+
name: "label_filter",
|
|
2993
|
+
required: false,
|
|
2994
|
+
schema: {
|
|
2995
|
+
type: "string",
|
|
2996
|
+
},
|
|
2997
|
+
"x-displayname": "Label Filter.",
|
|
2998
|
+
"x-ves-example": "Env in (staging, testing), tier in (web, db)",
|
|
2999
|
+
},
|
|
3000
|
+
{
|
|
3001
|
+
description: 'X-example: ""\nExtra fields to return along with summary fields.',
|
|
3002
|
+
in: "query",
|
|
3003
|
+
name: "report_fields",
|
|
3004
|
+
required: false,
|
|
3005
|
+
schema: {
|
|
3006
|
+
items: {
|
|
3007
|
+
type: "string",
|
|
3008
|
+
},
|
|
3009
|
+
type: "array",
|
|
3010
|
+
},
|
|
3011
|
+
"x-displayname": "Report Fields.",
|
|
3012
|
+
},
|
|
3013
|
+
{
|
|
3014
|
+
description: 'X-example: ""\nExtra status fields to return along with summary fields.',
|
|
3015
|
+
in: "query",
|
|
3016
|
+
name: "report_status_fields",
|
|
3017
|
+
required: false,
|
|
3018
|
+
schema: {
|
|
3019
|
+
items: {
|
|
3020
|
+
type: "string",
|
|
3021
|
+
},
|
|
3022
|
+
type: "array",
|
|
3023
|
+
},
|
|
3024
|
+
"x-displayname": "Report Status Fields.",
|
|
3025
|
+
},
|
|
3026
|
+
],
|
|
3027
|
+
requestBodySchema: null,
|
|
3028
|
+
responseSchema: {
|
|
3029
|
+
$ref: "#/components/schemas/k8s_pod_security_policyListResponse",
|
|
3030
|
+
},
|
|
3031
|
+
requiredParams: ["namespace"],
|
|
3032
|
+
operationId: "ves.io.schema.k8s_pod_security_policy.API.List",
|
|
3033
|
+
tags: ["Other"],
|
|
3034
|
+
sourceFile: "domains/managed_kubernetes.json",
|
|
3035
|
+
displayName: null,
|
|
3036
|
+
dangerLevel: "low",
|
|
3037
|
+
sideEffects: null,
|
|
3038
|
+
requiredFields: ["path.namespace"],
|
|
3039
|
+
cliExamples: [
|
|
3040
|
+
{
|
|
3041
|
+
command: "f5xcctl config k8s-pod-security-policy list --namespace {namespace}",
|
|
3042
|
+
description: "List all k8s-pod-security-policys",
|
|
3043
|
+
use_case: "list_all",
|
|
3044
|
+
},
|
|
3045
|
+
],
|
|
3046
|
+
confirmationRequired: false,
|
|
3047
|
+
parameterExamples: {
|
|
3048
|
+
label_filter: "Env in (staging, testing), tier in (web, db)",
|
|
3049
|
+
namespace: "Ns1",
|
|
3050
|
+
},
|
|
3051
|
+
validationRules: {},
|
|
3052
|
+
operationMetadata: {
|
|
3053
|
+
common_errors: [
|
|
3054
|
+
{
|
|
3055
|
+
code: 401,
|
|
3056
|
+
message: "Authentication required",
|
|
3057
|
+
solution: "Provide valid API credentials",
|
|
3058
|
+
},
|
|
3059
|
+
{
|
|
3060
|
+
code: 403,
|
|
3061
|
+
message: "Permission denied",
|
|
3062
|
+
solution: "Check access permissions for this operation",
|
|
3063
|
+
},
|
|
3064
|
+
{
|
|
3065
|
+
code: 404,
|
|
3066
|
+
message: "Resource not found",
|
|
3067
|
+
solution: "Verify resource name, namespace, and path",
|
|
3068
|
+
},
|
|
3069
|
+
{
|
|
3070
|
+
code: 409,
|
|
3071
|
+
message: "Resource already exists",
|
|
3072
|
+
solution: "Use different name or update existing resource",
|
|
3073
|
+
},
|
|
3074
|
+
{
|
|
3075
|
+
code: 429,
|
|
3076
|
+
message: "Rate limit exceeded",
|
|
3077
|
+
solution: "Wait before retrying the operation",
|
|
3078
|
+
},
|
|
3079
|
+
{
|
|
3080
|
+
code: 500,
|
|
3081
|
+
message: "Server error",
|
|
3082
|
+
solution: "Retry operation or contact support",
|
|
3083
|
+
},
|
|
3084
|
+
],
|
|
3085
|
+
conditions: {
|
|
3086
|
+
postconditions: [],
|
|
3087
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
3088
|
+
},
|
|
3089
|
+
confirmation_required: false,
|
|
3090
|
+
danger_level: "low",
|
|
3091
|
+
examples: [
|
|
3092
|
+
{
|
|
3093
|
+
command: "f5xcctl config k8s-pod-security-policy list --namespace {namespace}",
|
|
3094
|
+
description: "List all k8s-pod-security-policys",
|
|
3095
|
+
use_case: "list_all",
|
|
3096
|
+
},
|
|
3097
|
+
],
|
|
3098
|
+
field_docs: {},
|
|
3099
|
+
optional_fields: [],
|
|
3100
|
+
performance_impact: {
|
|
3101
|
+
latency: "moderate",
|
|
3102
|
+
resource_usage: "moderate",
|
|
3103
|
+
},
|
|
3104
|
+
purpose: "List all k8s-pod-security-policys",
|
|
3105
|
+
required_fields: ["path.namespace"],
|
|
3106
|
+
side_effects: {},
|
|
3107
|
+
},
|
|
3108
|
+
},
|
|
3109
|
+
{
|
|
3110
|
+
toolName: "f5xc-api-managedkubernetes-k8s-pod-security-policy-update",
|
|
3111
|
+
method: "PUT",
|
|
3112
|
+
path: "/api/config/namespaces/{metadata.namespace}/k8s_pod_security_policys/{metadata.name}",
|
|
3113
|
+
operation: "update",
|
|
3114
|
+
domain: "managed_kubernetes",
|
|
3115
|
+
resource: "k8s-pod-security-policy",
|
|
3116
|
+
summary: "Replace Configuration Specification.",
|
|
3117
|
+
description: "Replacing an k8s_pod_security_policy object will update the object by replacing the existing spec with the provided one.\nFor read-then-write operations a resourceVersion mismatch will occur if the object was modified between the read and write.",
|
|
3118
|
+
pathParameters: [
|
|
3119
|
+
{
|
|
3120
|
+
description: "Name\nThe configuration object to be replaced will be looked up by name.",
|
|
3121
|
+
in: "path",
|
|
3122
|
+
name: "metadata.name",
|
|
3123
|
+
required: true,
|
|
3124
|
+
schema: {
|
|
3125
|
+
type: "string",
|
|
3126
|
+
},
|
|
3127
|
+
"x-displayname": "Name",
|
|
3128
|
+
"x-ves-example": "Example-corp-web.",
|
|
3129
|
+
},
|
|
3130
|
+
{
|
|
3131
|
+
description: 'Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be ""',
|
|
3132
|
+
in: "path",
|
|
3133
|
+
name: "metadata.namespace",
|
|
3134
|
+
required: true,
|
|
3135
|
+
schema: {
|
|
3136
|
+
type: "string",
|
|
3137
|
+
},
|
|
3138
|
+
"x-displayname": "Namespace",
|
|
3139
|
+
"x-ves-example": "Staging",
|
|
3140
|
+
},
|
|
3141
|
+
],
|
|
3142
|
+
queryParameters: [],
|
|
3143
|
+
requestBodySchema: {
|
|
3144
|
+
$ref: "#/components/schemas/k8s_pod_security_policyReplaceRequest",
|
|
3145
|
+
},
|
|
3146
|
+
responseSchema: {
|
|
3147
|
+
$ref: "#/components/schemas/k8s_pod_security_policyReplaceResponse",
|
|
3148
|
+
},
|
|
3149
|
+
requiredParams: ["body", "metadata.name", "metadata.namespace"],
|
|
3150
|
+
operationId: "ves.io.schema.k8s_pod_security_policy.API.Replace",
|
|
3151
|
+
tags: ["Other"],
|
|
3152
|
+
sourceFile: "domains/managed_kubernetes.json",
|
|
3153
|
+
displayName: null,
|
|
3154
|
+
dangerLevel: "medium",
|
|
3155
|
+
sideEffects: {
|
|
3156
|
+
modifies: ["k8s-pod-security-policy"],
|
|
3157
|
+
},
|
|
3158
|
+
requiredFields: ["path.metadata.name", "path.metadata.namespace"],
|
|
3159
|
+
cliExamples: [
|
|
3160
|
+
{
|
|
3161
|
+
command: "f5xcctl config k8s-pod-security-policy update {name} --namespace {namespace} -f {file}.yaml",
|
|
3162
|
+
description: "Update k8s-pod-security-policy",
|
|
3163
|
+
use_case: "update",
|
|
3164
|
+
},
|
|
3165
|
+
],
|
|
3166
|
+
confirmationRequired: false,
|
|
3167
|
+
parameterExamples: {
|
|
3168
|
+
"metadata.name": "Example-corp-web.",
|
|
3169
|
+
"metadata.namespace": "Staging",
|
|
3170
|
+
},
|
|
3171
|
+
validationRules: {},
|
|
3172
|
+
operationMetadata: {
|
|
3173
|
+
common_errors: [
|
|
3174
|
+
{
|
|
3175
|
+
code: 401,
|
|
3176
|
+
message: "Authentication required",
|
|
3177
|
+
solution: "Provide valid API credentials",
|
|
3178
|
+
},
|
|
3179
|
+
{
|
|
3180
|
+
code: 403,
|
|
3181
|
+
message: "Permission denied",
|
|
3182
|
+
solution: "Check access permissions for this operation",
|
|
3183
|
+
},
|
|
3184
|
+
{
|
|
3185
|
+
code: 404,
|
|
3186
|
+
message: "Resource not found",
|
|
3187
|
+
solution: "Verify resource name, namespace, and path",
|
|
3188
|
+
},
|
|
3189
|
+
{
|
|
3190
|
+
code: 409,
|
|
3191
|
+
message: "Resource already exists",
|
|
3192
|
+
solution: "Use different name or update existing resource",
|
|
3193
|
+
},
|
|
3194
|
+
{
|
|
3195
|
+
code: 429,
|
|
3196
|
+
message: "Rate limit exceeded",
|
|
3197
|
+
solution: "Wait before retrying the operation",
|
|
3198
|
+
},
|
|
3199
|
+
{
|
|
3200
|
+
code: 500,
|
|
3201
|
+
message: "Server error",
|
|
3202
|
+
solution: "Retry operation or contact support",
|
|
3203
|
+
},
|
|
3204
|
+
],
|
|
3205
|
+
conditions: {
|
|
3206
|
+
postconditions: ["Resource updated with new values"],
|
|
3207
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
3208
|
+
},
|
|
3209
|
+
confirmation_required: false,
|
|
3210
|
+
danger_level: "medium",
|
|
3211
|
+
examples: [
|
|
3212
|
+
{
|
|
3213
|
+
command: "f5xcctl config k8s-pod-security-policy update {name} --namespace {namespace} -f {file}.yaml",
|
|
3214
|
+
description: "Update k8s-pod-security-policy",
|
|
3215
|
+
use_case: "update",
|
|
3216
|
+
},
|
|
3217
|
+
],
|
|
3218
|
+
field_docs: {},
|
|
3219
|
+
optional_fields: [],
|
|
3220
|
+
performance_impact: {
|
|
3221
|
+
latency: "low",
|
|
3222
|
+
resource_usage: "low",
|
|
3223
|
+
},
|
|
3224
|
+
purpose: "Replace existing k8s-pod-security-policy",
|
|
3225
|
+
required_fields: ["path.metadata.name", "path.metadata.namespace"],
|
|
3226
|
+
side_effects: {
|
|
3227
|
+
modifies: ["k8s-pod-security-policy"],
|
|
3228
|
+
},
|
|
3229
|
+
},
|
|
3230
|
+
},
|
|
3231
|
+
];
|
|
3232
|
+
export default managed_kubernetesTools;
|
|
3233
|
+
//# sourceMappingURL=index.js.map
|