You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The console plugin API has been made GA quite a few OpenShift
versions back (in OCP 4.12).
* Update the API version to make the plugin work on newer versions
of OpenShift.
* Makes the port number a variable.
* Bump the Helm chart version.
* Update the image build.
* Update the documentation.
Red Hat OpenShift dynamic console plugin that leverages the NVIDIA GPU operator metrics and serves the respective console-extensions. Requires Red Hat OpenShift version 4.11+
4
+
Red Hat OpenShift dynamic console plugin that leverages the NVIDIA GPU operator metrics and serves the respective console-extensions. Requires Red Hat OpenShift version 4.12+
Copy file name to clipboardExpand all lines: deployment/hack/crds/consoleplugin.customresourcedefinition.yaml
+193-1Lines changed: 193 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -13,6 +13,198 @@ spec:
13
13
singular: consoleplugin
14
14
scope: Cluster
15
15
versions:
16
+
- name: v1
17
+
schema:
18
+
openAPIV3Schema:
19
+
description: "ConsolePlugin is an extension for customizing OpenShift web
20
+
console by dynamically loading code from another service running on the
21
+
cluster. \n Compatibility level 1: Stable within a major release for a minimum
22
+
of 12 months or 3 minor releases (whichever is longer)."
23
+
properties:
24
+
apiVersion:
25
+
description: 'APIVersion defines the versioned schema of this representation
26
+
of an object. Servers should convert recognized schemas to the latest
27
+
internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
28
+
type: string
29
+
kind:
30
+
description: 'Kind is a string value representing the REST resource this
31
+
object represents. Servers may infer this from the endpoint the client
32
+
submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
33
+
type: string
34
+
metadata:
35
+
type: object
36
+
spec:
37
+
description: ConsolePluginSpec is the desired plugin configuration.
38
+
properties:
39
+
backend:
40
+
description: backend holds the configuration of backend which is serving
41
+
console's plugin .
42
+
properties:
43
+
service:
44
+
description: service is a Kubernetes Service that exposes the
45
+
plugin using a deployment with an HTTP server. The Service must
46
+
use HTTPS and Service serving certificate. The console backend
47
+
will proxy the plugins assets from the Service using the service
48
+
CA bundle.
49
+
properties:
50
+
basePath:
51
+
default: /
52
+
description: basePath is the path to the plugin's assets.
53
+
The primary asset it the manifest file called `plugin-manifest.json`,
54
+
which is a JSON document that contains metadata about the
55
+
plugin and the extensions.
56
+
maxLength: 256
57
+
minLength: 1
58
+
pattern: ^[a-zA-Z0-9.\-_~!$&'()*+,;=:@\/]*$
59
+
type: string
60
+
name:
61
+
description: name of Service that is serving the plugin assets.
62
+
maxLength: 128
63
+
minLength: 1
64
+
type: string
65
+
namespace:
66
+
description: namespace of Service that is serving the plugin
67
+
assets.
68
+
maxLength: 128
69
+
minLength: 1
70
+
type: string
71
+
port:
72
+
description: port on which the Service that is serving the
73
+
plugin is listening to.
74
+
format: int32
75
+
maximum: 65535
76
+
minimum: 1
77
+
type: integer
78
+
required:
79
+
- name
80
+
- namespace
81
+
- port
82
+
type: object
83
+
type:
84
+
description: "type is the backend type which servers the console's
85
+
plugin. Currently only \"Service\" is supported. \n ---"
86
+
enum:
87
+
- Service
88
+
type: string
89
+
required:
90
+
- type
91
+
type: object
92
+
displayName:
93
+
description: displayName is the display name of the plugin. The dispalyName
94
+
should be between 1 and 128 characters.
95
+
maxLength: 128
96
+
minLength: 1
97
+
type: string
98
+
i18n:
99
+
description: i18n is the configuration of plugin's localization resources.
100
+
properties:
101
+
loadType:
102
+
description: loadType indicates how the plugin's localization
103
+
resource should be loaded. Valid values are Preload, Lazy and
104
+
the empty string. When set to Preload, all localization resources
105
+
are fetched when the plugin is loaded. When set to Lazy, localization
106
+
resources are lazily loaded as and when they are required by
107
+
the console. When omitted or set to the empty string, the behaviour
108
+
is equivalent to Lazy type.
109
+
enum:
110
+
- Preload
111
+
- Lazy
112
+
- ""
113
+
type: string
114
+
required:
115
+
- loadType
116
+
type: object
117
+
proxy:
118
+
description: proxy is a list of proxies that describe various service
119
+
type to which the plugin needs to connect to.
120
+
items:
121
+
description: ConsolePluginProxy holds information on various service
122
+
types to which console's backend will proxy the plugin's requests.
123
+
properties:
124
+
alias:
125
+
description: "alias is a proxy name that identifies the plugin's
126
+
proxy. An alias name should be unique per plugin. The console
127
+
backend exposes following proxy endpoint: \n /api/proxy/plugin/<plugin-name>/<proxy-alias>/<request-path>?<optional-query-parameters>
128
+
\n Request example path: \n /api/proxy/plugin/acm/search/pods?namespace=openshift-apiserver"
129
+
maxLength: 128
130
+
minLength: 1
131
+
pattern: ^[A-Za-z0-9-_]+$
132
+
type: string
133
+
authorization:
134
+
default: None
135
+
description: authorization provides information about authorization
136
+
type, which the proxied request should contain
137
+
enum:
138
+
- UserToken
139
+
- None
140
+
type: string
141
+
caCertificate:
142
+
description: caCertificate provides the cert authority certificate
143
+
contents, in case the proxied Service is using custom service
144
+
CA. By default, the service CA bundle provided by the service-ca
0 commit comments