mirror of
https://github.com/open-cluster-management-io/ocm.git
synced 2026-05-20 16:14:23 +00:00
295 lines
16 KiB
YAML
295 lines
16 KiB
YAML
apiVersion: apiextensions.k8s.io/v1
|
|
kind: CustomResourceDefinition
|
|
metadata:
|
|
annotations:
|
|
api-approved.openshift.io: https://github.com/openshift/api/pull/1186
|
|
capability.openshift.io/name: Console
|
|
description: Extension for configuring openshift web console plugins.
|
|
displayName: ConsolePlugin
|
|
include.release.openshift.io/ibm-cloud-managed: "true"
|
|
include.release.openshift.io/self-managed-high-availability: "true"
|
|
include.release.openshift.io/single-node-developer: "true"
|
|
service.beta.openshift.io/inject-cabundle: "true"
|
|
name: consoleplugins.console.openshift.io
|
|
spec:
|
|
conversion:
|
|
strategy: Webhook
|
|
webhook:
|
|
clientConfig:
|
|
service:
|
|
name: webhook
|
|
namespace: openshift-console-operator
|
|
path: /crdconvert
|
|
port: 9443
|
|
conversionReviewVersions:
|
|
- v1
|
|
- v1alpha1
|
|
group: console.openshift.io
|
|
names:
|
|
kind: ConsolePlugin
|
|
listKind: ConsolePluginList
|
|
plural: consoleplugins
|
|
singular: consoleplugin
|
|
scope: Cluster
|
|
versions:
|
|
- name: v1
|
|
schema:
|
|
openAPIV3Schema:
|
|
description: "ConsolePlugin is an extension for customizing OpenShift web console by dynamically loading code from another service running on the cluster. \n Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer)."
|
|
type: object
|
|
required:
|
|
- metadata
|
|
- spec
|
|
properties:
|
|
apiVersion:
|
|
description: 'APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
|
|
type: string
|
|
kind:
|
|
description: 'Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
|
|
type: string
|
|
metadata:
|
|
type: object
|
|
spec:
|
|
description: ConsolePluginSpec is the desired plugin configuration.
|
|
type: object
|
|
required:
|
|
- backend
|
|
- displayName
|
|
properties:
|
|
backend:
|
|
description: backend holds the configuration of backend which is serving console's plugin .
|
|
type: object
|
|
required:
|
|
- type
|
|
properties:
|
|
service:
|
|
description: service is a Kubernetes Service that exposes the plugin using a deployment with an HTTP server. The Service must use HTTPS and Service serving certificate. The console backend will proxy the plugins assets from the Service using the service CA bundle.
|
|
type: object
|
|
required:
|
|
- name
|
|
- namespace
|
|
- port
|
|
properties:
|
|
basePath:
|
|
description: basePath is the path to the plugin's assets. The primary asset it the manifest file called `plugin-manifest.json`, which is a JSON document that contains metadata about the plugin and the extensions.
|
|
type: string
|
|
default: /
|
|
maxLength: 256
|
|
minLength: 1
|
|
pattern: ^[a-zA-Z0-9.\-_~!$&'()*+,;=:@\/]*$
|
|
name:
|
|
description: name of Service that is serving the plugin assets.
|
|
type: string
|
|
maxLength: 128
|
|
minLength: 1
|
|
namespace:
|
|
description: namespace of Service that is serving the plugin assets.
|
|
type: string
|
|
maxLength: 128
|
|
minLength: 1
|
|
port:
|
|
description: port on which the Service that is serving the plugin is listening to.
|
|
type: integer
|
|
format: int32
|
|
maximum: 65535
|
|
minimum: 1
|
|
type:
|
|
description: "type is the backend type which servers the console's plugin. Currently only \"Service\" is supported. \n ---"
|
|
type: string
|
|
enum:
|
|
- Service
|
|
displayName:
|
|
description: displayName is the display name of the plugin. The dispalyName should be between 1 and 128 characters.
|
|
type: string
|
|
maxLength: 128
|
|
minLength: 1
|
|
i18n:
|
|
description: i18n is the configuration of plugin's localization resources.
|
|
type: object
|
|
required:
|
|
- loadType
|
|
properties:
|
|
loadType:
|
|
description: loadType indicates how the plugin's localization resource should be loaded. Valid values are Preload, Lazy and the empty string. When set to Preload, all localization resources are fetched when the plugin is loaded. When set to Lazy, localization resources are lazily loaded as and when they are required by the console. When omitted or set to the empty string, the behaviour is equivalent to Lazy type.
|
|
type: string
|
|
enum:
|
|
- Preload
|
|
- Lazy
|
|
- ""
|
|
proxy:
|
|
description: proxy is a list of proxies that describe various service type to which the plugin needs to connect to.
|
|
type: array
|
|
items:
|
|
description: ConsolePluginProxy holds information on various service types to which console's backend will proxy the plugin's requests.
|
|
type: object
|
|
required:
|
|
- alias
|
|
- endpoint
|
|
properties:
|
|
alias:
|
|
description: "alias is a proxy name that identifies the plugin's proxy. An alias name should be unique per plugin. The console backend exposes following proxy endpoint: \n /api/proxy/plugin/<plugin-name>/<proxy-alias>/<request-path>?<optional-query-parameters> \n Request example path: \n /api/proxy/plugin/acm/search/pods?namespace=openshift-apiserver"
|
|
type: string
|
|
maxLength: 128
|
|
minLength: 1
|
|
pattern: ^[A-Za-z0-9-_]+$
|
|
authorization:
|
|
description: authorization provides information about authorization type, which the proxied request should contain
|
|
type: string
|
|
default: None
|
|
enum:
|
|
- UserToken
|
|
- None
|
|
caCertificate:
|
|
description: caCertificate provides the cert authority certificate contents, in case the proxied Service is using custom service CA. By default, the service CA bundle provided by the service-ca operator is used.
|
|
type: string
|
|
pattern: ^-----BEGIN CERTIFICATE-----([\s\S]*)-----END CERTIFICATE-----\s?$
|
|
endpoint:
|
|
description: endpoint provides information about endpoint to which the request is proxied to.
|
|
type: object
|
|
required:
|
|
- type
|
|
properties:
|
|
service:
|
|
description: 'service is an in-cluster Service that the plugin will connect to. The Service must use HTTPS. The console backend exposes an endpoint in order to proxy communication between the plugin and the Service. Note: service field is required for now, since currently only "Service" type is supported.'
|
|
type: object
|
|
required:
|
|
- name
|
|
- namespace
|
|
- port
|
|
properties:
|
|
name:
|
|
description: name of Service that the plugin needs to connect to.
|
|
type: string
|
|
maxLength: 128
|
|
minLength: 1
|
|
namespace:
|
|
description: namespace of Service that the plugin needs to connect to
|
|
type: string
|
|
maxLength: 128
|
|
minLength: 1
|
|
port:
|
|
description: port on which the Service that the plugin needs to connect to is listening on.
|
|
type: integer
|
|
format: int32
|
|
maximum: 65535
|
|
minimum: 1
|
|
type:
|
|
description: "type is the type of the console plugin's proxy. Currently only \"Service\" is supported. \n ---"
|
|
type: string
|
|
enum:
|
|
- Service
|
|
served: true
|
|
storage: false
|
|
- name: v1alpha1
|
|
schema:
|
|
openAPIV3Schema:
|
|
description: "ConsolePlugin is an extension for customizing OpenShift web console by dynamically loading code from another service running on the cluster. \n Compatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support."
|
|
type: object
|
|
required:
|
|
- metadata
|
|
- spec
|
|
properties:
|
|
apiVersion:
|
|
description: 'APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
|
|
type: string
|
|
kind:
|
|
description: 'Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
|
|
type: string
|
|
metadata:
|
|
type: object
|
|
spec:
|
|
description: ConsolePluginSpec is the desired plugin configuration.
|
|
type: object
|
|
required:
|
|
- service
|
|
properties:
|
|
displayName:
|
|
description: displayName is the display name of the plugin.
|
|
type: string
|
|
minLength: 1
|
|
proxy:
|
|
description: proxy is a list of proxies that describe various service type to which the plugin needs to connect to.
|
|
type: array
|
|
items:
|
|
description: ConsolePluginProxy holds information on various service types to which console's backend will proxy the plugin's requests.
|
|
type: object
|
|
required:
|
|
- alias
|
|
- type
|
|
properties:
|
|
alias:
|
|
description: "alias is a proxy name that identifies the plugin's proxy. An alias name should be unique per plugin. The console backend exposes following proxy endpoint: \n /api/proxy/plugin/<plugin-name>/<proxy-alias>/<request-path>?<optional-query-parameters> \n Request example path: \n /api/proxy/plugin/acm/search/pods?namespace=openshift-apiserver"
|
|
type: string
|
|
maxLength: 128
|
|
minLength: 1
|
|
pattern: ^[A-Za-z0-9-_]+$
|
|
authorize:
|
|
description: "authorize indicates if the proxied request should contain the logged-in user's OpenShift access token in the \"Authorization\" request header. For example: \n Authorization: Bearer sha256~kV46hPnEYhCWFnB85r5NrprAxggzgb6GOeLbgcKNsH0 \n By default the access token is not part of the proxied request."
|
|
type: boolean
|
|
default: false
|
|
caCertificate:
|
|
description: caCertificate provides the cert authority certificate contents, in case the proxied Service is using custom service CA. By default, the service CA bundle provided by the service-ca operator is used.
|
|
type: string
|
|
pattern: ^-----BEGIN CERTIFICATE-----([\s\S]*)-----END CERTIFICATE-----\s?$
|
|
service:
|
|
description: 'service is an in-cluster Service that the plugin will connect to. The Service must use HTTPS. The console backend exposes an endpoint in order to proxy communication between the plugin and the Service. Note: service field is required for now, since currently only "Service" type is supported.'
|
|
type: object
|
|
required:
|
|
- name
|
|
- namespace
|
|
- port
|
|
properties:
|
|
name:
|
|
description: name of Service that the plugin needs to connect to.
|
|
type: string
|
|
maxLength: 128
|
|
minLength: 1
|
|
namespace:
|
|
description: namespace of Service that the plugin needs to connect to
|
|
type: string
|
|
maxLength: 128
|
|
minLength: 1
|
|
port:
|
|
description: port on which the Service that the plugin needs to connect to is listening on.
|
|
type: integer
|
|
format: int32
|
|
maximum: 65535
|
|
minimum: 1
|
|
type:
|
|
description: type is the type of the console plugin's proxy. Currently only "Service" is supported.
|
|
type: string
|
|
pattern: ^(Service)$
|
|
service:
|
|
description: service is a Kubernetes Service that exposes the plugin using a deployment with an HTTP server. The Service must use HTTPS and Service serving certificate. The console backend will proxy the plugins assets from the Service using the service CA bundle.
|
|
type: object
|
|
required:
|
|
- basePath
|
|
- name
|
|
- namespace
|
|
- port
|
|
properties:
|
|
basePath:
|
|
description: basePath is the path to the plugin's assets. The primary asset it the manifest file called `plugin-manifest.json`, which is a JSON document that contains metadata about the plugin and the extensions.
|
|
type: string
|
|
default: /
|
|
minLength: 1
|
|
pattern: ^/
|
|
name:
|
|
description: name of Service that is serving the plugin assets.
|
|
type: string
|
|
maxLength: 128
|
|
minLength: 1
|
|
namespace:
|
|
description: namespace of Service that is serving the plugin assets.
|
|
type: string
|
|
maxLength: 128
|
|
minLength: 1
|
|
port:
|
|
description: port on which the Service that is serving the plugin is listening to.
|
|
type: integer
|
|
format: int32
|
|
maximum: 65535
|
|
minimum: 1
|
|
served: true
|
|
storage: true
|