Skip to content
This repository has been archived by the owner on Jul 31, 2023. It is now read-only.

Latest commit

 

History

History
49 lines (24 loc) · 2.47 KB

annotations.md

File metadata and controls

49 lines (24 loc) · 2.47 KB
Raw

Supported Annotations

Prism supports the following annotations in the metadata section of all Kubernetes standard and custom resources:

  1. prism.subkind: <subkind value>

    The prism.subkind annotation qualifies a Kubernetes resource kind. For example, qualifying that a deployment is Liberty or Node.js. The subkind specification plays a role in action config map selection for a Kubernetes resource as it appears in the Prism Application and Component level views.

    See Action Config Maps and UI layout for further details.

    The <subkind value> must be a valid Kubernetes resource kind name. The subkind annotation is optional. There is no default. If not specified, the resource simply has no subkind. The following pre-defined subkinds are used by Prism:

    1. Liberty
    2. Nodejs
    3. Swift

    Note: the character set for subkind:

    The prism.subkind value must consist of lower case alphanumeric characters or '-', start with an alphabetic character, and end with an alphanumeric character (e.g. 'my-name', or 'abc-123', regex used for validation is 'a-z?')

  2. prism.platform : <platform value>

    The prism.platform annotation identifies the platform on which a Kubernetes resource is deployed. This information is used primarily to promote end user understanding while interacting with an application through the Prism UI.

    The <platform value> must be a valid Kubernetes resource kind name. The platform annotation is optional. The default is 'Kube'.

    The following pre-defined platform values are used by Prism:

    1. Kube

      Specifies the platform is a Kubernetes cluster.

    2. WASCell

      Specifies the platform is a WebSphere Application Server Network Deployment cell.

    3. VM

      Specifies the platform is a virtual machine.

  3. prism.platform.name:

    The prism.platform.name annotation identifies the name of the platform on which a Kubernetes resource is deployed. This information is used primarily to promote end user understanding while interacting with an application through the Prism UI.

    The <platform name value> must be a valid Kubernetes resource name. There is no default value. If platform name is not specified, the resource simply has not exposed the name of the platform on which it is deployed.