Skip to content

Latest commit

 

History

History
89 lines (73 loc) · 3.9 KB

README.md

File metadata and controls

89 lines (73 loc) · 3.9 KB
Raw

OCS UI Features

The OCS UI requires some annotations in the OCS Operator CSV and Storage Cluster CR to perform various actions.

Following table maps the annotation to its use case and accepted values:

Annotation Name Purpose Accepted Values CR/CSV
features.ocs.openshift.io/enabled Activates Optional Features "multus", "flexible-scaling", "kms", "arbiter", "taint-nodes", "pool-management", "thick-provision" Operator CSV
cluster.ocs.openshift.io/local-devices Activates disk replacement and ocs status column in disk inventory "true" Storage Cluster CR
external.features.ocs.openshift.io/validation Mininum required keys to be supplied by the admin to connect to an external cluster Array of Keys that need to be validated in UI Operator CSV

Enabling Features in UI

UI features are activated based on the annotations. The following table maps a feature and the respective annotation key-value pair required to activate it.

Feature Annotation Value Annotation Key
Flexible scaling features.ocs.openshift.io/enabled flexible-scaling
KMS encryption features.ocs.openshift.io/enabled kms
Arbiter features.ocs.openshift.io/enabled arbiter
Multus features.ocs.openshift.io/enabled multus
Taint nodes features.ocs.openshift.io/enabled taint-nodes
Pool management features.ocs.openshift.io/enabled pool-management
Thick Provision features.ocs.openshift.io/enabled thick-provision
MCG standalone deployment features.ocs.openshift.io/enabled mcg-standalone
Disk Replacement Action cluster.ocs.openshift.io/local-devices true
Disk Inventory OCS Status Column cluster.ocs.openshift.io/local-devices true

Example

   "features.ocs.openshift.io/enabled": `["multus"]`

JSON validation (Independent Mode)

This is used to perform validation of the JSON file uploaded by the user during Independent mode installation. The values in external.ocs.openshift.io/validation annotation needs to be a stringified JSON. The JSON object should have the following keys and values:

Key Accepted Values Validation Performed
secrets Array of String JSON should contain all the secrets defined in the array. The data.userKey /data.adminKey field should be Base64 encoded and non-empty.
configMaps Array of String JSON should contain all the configMaps defined in the array. data field should be non-empty.
storageClasses Array of String JSON should contain all the storageClasses defined in the array. data field should be non-empty.

Example (CSV Annotataton)

external.features.ocs.openshift.io/validation: '{"secrets":["rook-ceph-operator-creds",

"rook-csi-rbd-node", "rook-csi-rbd-provisioner", "rook-csi-cephfs-node", rook-csi-cephfs-provisioner"],

"configMaps": ["rook-ceph-mon-endpoints", "rook-ceph-mon"], "storageClasses":

["rook-ceph-retain-bucket"]}'

Example (User Uploaded JSON)

Excerpt of the JSON uploaded by the user.

[
	{
		"kind": "ConfigMap",
		"data": {
			"maxMonId": "0",
			"data": "a=10.106.31.93:6789",
			"mapping": {}
		},
		"name": "rook-ceph-mon-endpoints"
	},
	{
		"kind": "Secret",
		"data": {
			"userKey": "AQBI8bteZd52HxAAAgHS3TJGEfgZurN+gVvDNQ==",
			"userID": "client.aaaa"
		},
		"name": "rook-ceph-operator-creds"
	},
	{
		"kind": "Secret",
		"data": {
			"adminID": "csi-cephfs-provisioner",
			"adminKey": "AQBV66pefnqmERAAKYhoO2XK5mUIGKSN4J/URw=="
		},
		"name": "rook-csi-cephfs-provisioner"
	},
	{
		"kind": "StorageClass",
		"data": {
			"pool": "device_health_metrics"
		},
		"name": "ceph-rbd"
	},
]