salt: Use csc framework for UI configuration #3181

JBWatenbergScality · 2021-03-09T11:03:30Z

Component:

'salt'

Context:

UI configuration can be patched in order to match a specific environment constraints.
Before this PR any upgrade of metalk8s would revert those patches.

Summary:

Introducing CSC framework for ui configuration management allows deploying upgrade using a configmap merge approach in order to avoid losing config patches.

Work in progress:

~~- [x] Add JSON support to CSC framework~~

Use CSC framework similar to things that we achieved for other services (such as Dex) for metalk8s UI and shell-ui
Add a section to document development guide mentioning the ability to configure menu options, role mapping and theme (https://metal-k8s.readthedocs.io/en/latest/developer/architecture/configurations.html#available-settings)
Add a detailed section to operation documentation about how to customise menu options, role mapping and theme (https://metal-k8s.readthedocs.io/en/latest/operation/cluster_and_service_configuration.html)

Acceptance criteria:

After an upgrade on a platform where UI configmap were patched, updated configmaps should preserved the overrides in place before the upgrade.

Closes: #3175

salt/_modules/metalk8s_service_configuration.py

JBWatenbergScality · 2021-03-12T09:22:33Z

@bert-e after_pull_request=3154

salt/metalk8s/addons/ui/deployed/ui-configuration.sls

bert-e · 2021-03-15T18:27:26Z

Hello jbwatenbergscality,

My role is to assist you with the merge of this
pull request. Please type @bert-e help to get information
on this process, or consult the user documentation.

Status report is not available.

bert-e · 2021-03-15T18:27:30Z

Waiting for approval

The following approvals are needed before I can proceed with the merge:

the author
one peer

Peer approvals must include at least 1 approval from the following list:

The following options are set: after_pull_request

gdemonet

Mostly docs changes, and renaming for apiVersion and kind.

docs/developer/architecture/configurations.rst

docs/operation/cluster_and_service_configuration.rst

salt/_modules/metalk8s_service_configuration.py

salt/metalk8s/addons/ui/config/metalk8s-ui-config.yaml

salt/metalk8s/addons/ui/config/metalk8s-shell-ui-config.yaml.j2

salt/metalk8s/addons/ui/config/metalk8s-theme.yaml.in

bert-e · 2021-03-17T14:36:19Z

Waiting for approval

The following approvals are needed before I can proceed with the merge:

the author
one peer

Peer approvals must include at least 1 approval from the following list:

The following reviewers are expecting changes from the author, or must review again:

@gdemonet

The following options are set: after_pull_request

gdemonet

Some apiVersion/kind updates were not propagated

gdemonet · 2021-03-19T12:10:40Z

salt/metalk8s/addons/ui/config/metalk8s-theme.yaml.in

+#!yaml
+
+# Defaults for configuration of MetalK8s UI
+apiVersion: addons.metalk8s.scality.com


Suggested change

apiVersion: addons.metalk8s.scality.com

apiVersion: addons.metalk8s.scality.com/v1alpha1

gdemonet · 2021-03-19T12:10:56Z

salt/metalk8s/addons/ui/config/metalk8s-shell-ui-config.yaml.j2

+#!jinja|yaml
+
+# Defaults for shell UI configuration
+apiVersion: addons.metalk8s.scality.com


Suggested change

apiVersion: addons.metalk8s.scality.com

apiVersion: addons.metalk8s.scality.com/v1alpha1

gdemonet · 2021-03-19T12:11:31Z

salt/metalk8s/addons/ui/deployed/ui-configuration.sls

+          namespace: metalk8s-ui
+        data:
+          config.yaml: |-
+            apiVersion: addons.metalk8s.scality.com


Suggested change

apiVersion: addons.metalk8s.scality.com

apiVersion: addons.metalk8s.scality.com/v1alpha1

gdemonet · 2021-03-19T12:11:41Z

salt/metalk8s/addons/ui/deployed/ui-configuration.sls

+        data:
+          config.yaml: |-
+            apiVersion: addons.metalk8s.scality.com
+            kind: Metalk8sUIConfig


Suggested change

kind: Metalk8sUIConfig

kind: UIConfig

gdemonet · 2021-03-19T12:11:56Z

salt/metalk8s/addons/ui/deployed/ui-configuration.sls

+          namespace: metalk8s-ui
+        data:
+          config.yaml: |-
+            apiVersion: addons.metalk8s.scality.com


Suggested change

apiVersion: addons.metalk8s.scality.com

apiVersion: addons.metalk8s.scality.com/v1alpha1

gdemonet · 2021-03-19T12:13:36Z

docs/operation/cluster_and_service_configuration.rst

+    kind: ConfigMap
+    data:
+      config.yaml: |-
+        apiVersion: addons.metalk8s.scality.com


Suggested change

apiVersion: addons.metalk8s.scality.com

apiVersion: addons.metalk8s.scality.com/v1alpha1

gdemonet · 2021-03-19T12:13:50Z

docs/operation/cluster_and_service_configuration.rst

+    data:
+      config.yaml: |-
+        apiVersion: addons.metalk8s.scality.com
+        kind: Metalk8sShellUIConfig


Suggested change

kind: Metalk8sShellUIConfig

kind: ShellUIConfig

gdemonet · 2021-03-19T12:13:59Z

docs/operation/cluster_and_service_configuration.rst

+    kind: ConfigMap
+    data:
+      config.yaml: |-
+        apiVersion: addons.metalk8s.scality.com


Suggested change

apiVersion: addons.metalk8s.scality.com

apiVersion: addons.metalk8s.scality.com/v1alpha1

gdemonet · 2021-03-19T12:15:11Z

docs/operation/cluster_and_service_configuration.rst

+    data:
+      config.yaml: |-
+        apiVersion: addons.metalk8s.scality.com
+        kind: Metalk8sUIConfig


Suggested change

kind: Metalk8sUIConfig

kind: UIConfig

gdemonet · 2021-03-19T12:15:19Z

docs/operation/cluster_and_service_configuration.rst

+    kind: ConfigMap
+    data:
+      config.yaml: |-
+        apiVersion: addons.metalk8s.scality.com


Suggested change

apiVersion: addons.metalk8s.scality.com

apiVersion: addons.metalk8s.scality.com/v1alpha1

Refs: #3175

… create ui config map before its consumers

gdemonet

Feel free to ignore if you have a green build, but if you don't and need to rebuild, please fix those headers :)

gdemonet · 2021-03-22T09:59:07Z

docs/operation/cluster_and_service_configuration.rst

+Changing the MetalK8s UI Ingress Path
+""""""""""""""""""""""""""""""""""""""""""""""""


It's not "critical" but still a bit ugly 😜

Suggested change

Changing the MetalK8s UI Ingress Path

""""""""""""""""""""""""""""""""""""""""""""""""

Changing the MetalK8s UI Ingress Path

"""""""""""""""""""""""""""""""""""""

I took care of it in #3196

gdemonet · 2021-03-22T09:59:38Z

docs/operation/cluster_and_service_configuration.rst

+MetalK8s UI Theme Customization
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


Suggested change

MetalK8s UI Theme Customization

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

MetalK8s UI Theme Customization

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

gdemonet · 2021-03-22T09:59:58Z

docs/operation/cluster_and_service_configuration.rst

+
+Once the theme is edited, apply your changes by running:
+
+


Extra empty line, to remove

bert-e · 2021-03-22T10:02:16Z

Waiting for approval

The following approvals are needed before I can proceed with the merge:

the author
one peer

Peer approvals must include at least 1 approval from the following list:

The following options are set: after_pull_request

JBWatenbergScality · 2021-03-22T12:04:17Z

/approve

bert-e · 2021-03-22T12:04:26Z

In the queue

The changeset has received all authorizations and has been added to the
relevant queue(s). The queue(s) will be merged in the target development
branch(es) as soon as builds have passed.

The changeset will be merged in:

✔️ development/2.9

The following branches will NOT be impacted:

development/1.0
development/1.1
development/1.2
development/1.3
development/2.0
development/2.1
development/2.2
development/2.3
development/2.4
development/2.5
development/2.6
development/2.7
development/2.8

There is no action required on your side. You will be notified here once
the changeset has been merged. In the unlikely event that the changeset
fails permanently on the queue, a member of the admin team will
contact you to help resolve the matter.

IMPORTANT

Please do not attempt to modify this pull request.

Any commit you add on the source branch will trigger a new cycle after the
current queue is merged.
Any commit you add on one of the integration branches will be lost.

If you need this pull request to be removed from the queue, please contact a
member of the admin team now.

The following options are set: approve, after_pull_request

bert-e · 2021-03-22T13:51:06Z

I have successfully merged the changeset of this pull request
into targetted development branches:

✔️ development/2.9

The following branches have NOT changed:

development/1.0
development/1.1
development/1.2
development/1.3
development/2.0
development/2.1
development/2.2
development/2.3
development/2.4
development/2.5
development/2.6
development/2.7
development/2.8

Please check the status of the associated issue None.

Goodbye jbwatenbergscality.

JBWatenbergScality added the topic:salt Everything related to SaltStack in our product label Mar 9, 2021

gdemonet reviewed Mar 9, 2021

View reviewed changes

salt/_modules/metalk8s_service_configuration.py Outdated Show resolved Hide resolved

JBWatenbergScality force-pushed the improvement/shell-ui-make-navbar-options-configurable branch from 904782f to d870add Compare March 9, 2021 18:13

JBWatenbergScality force-pushed the improvement/use-csc-framework-for-ui-configuration branch 7 times, most recently from 5bbb026 to e6ab115 Compare March 11, 2021 15:18

JBWatenbergScality marked this pull request as ready for review March 11, 2021 15:19

JBWatenbergScality requested a review from a team as a code owner March 11, 2021 15:19

JBWatenbergScality mentioned this pull request Mar 12, 2021

shell-ui : Add users group mapping in shell UI config #3196

Merged

JBWatenbergScality force-pushed the improvement/use-csc-framework-for-ui-configuration branch from e6ab115 to 480e0d9 Compare March 12, 2021 09:13

JBWatenbergScality force-pushed the improvement/use-csc-framework-for-ui-configuration branch from 480e0d9 to df63277 Compare March 12, 2021 09:36

JBWatenbergScality force-pushed the improvement/shell-ui-make-navbar-options-configurable branch 2 times, most recently from 06a5496 to 06e1b08 Compare March 15, 2021 11:31

JBWatenbergScality force-pushed the improvement/use-csc-framework-for-ui-configuration branch from df63277 to 04a7330 Compare March 15, 2021 11:35

gdemonet reviewed Mar 15, 2021

View reviewed changes

salt/metalk8s/addons/ui/deployed/ui-configuration.sls Outdated Show resolved Hide resolved

Base automatically changed from improvement/shell-ui-make-navbar-options-configurable to development/2.9 March 15, 2021 18:27

JBWatenbergScality force-pushed the improvement/use-csc-framework-for-ui-configuration branch 3 times, most recently from a269acb to 824a204 Compare March 17, 2021 11:38

gdemonet suggested changes Mar 17, 2021

View reviewed changes

JBWatenbergScality force-pushed the improvement/use-csc-framework-for-ui-configuration branch 2 times, most recently from 5181a5b to c7d42f6 Compare March 17, 2021 16:02

JBWatenbergScality force-pushed the improvement/use-csc-framework-for-ui-configuration branch 8 times, most recently from 6d621ec to f55efb7 Compare March 18, 2021 19:23

gdemonet suggested changes Mar 19, 2021

View reviewed changes

JBWatenbergScality added 6 commits March 19, 2021 18:37

salt: Use csc framework to configure UI deployment path

d935de9

Refs: #3175

salt: Use csc framework to configure UI theme

aed95a4

Refs: #3175

salt: Use csc framework to configure shell UI

4cb5f22

Refs: #3175

salt: Reference ui configuration in service configuration in order to…

ded4746

… create ui config map before its consumers

salt: Fix Shell UI tragets

bc98afc

test: Add support for .in templates in salt formulas tests

dc7625a

JBWatenbergScality force-pushed the improvement/use-csc-framework-for-ui-configuration branch from 9ec3291 to dc7625a Compare March 19, 2021 17:37

gdemonet approved these changes Mar 22, 2021

View reviewed changes

bert-e merged commit d7a2c95 into development/2.9 Mar 22, 2021

bert-e deleted the improvement/use-csc-framework-for-ui-configuration branch March 22, 2021 13:51

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

salt: Use csc framework for UI configuration #3181

salt: Use csc framework for UI configuration #3181

JBWatenbergScality commented Mar 9, 2021 •

edited

Loading

JBWatenbergScality commented Mar 12, 2021

bert-e commented Mar 15, 2021

bert-e commented Mar 15, 2021

gdemonet left a comment

bert-e commented Mar 17, 2021

gdemonet left a comment

gdemonet Mar 19, 2021

gdemonet Mar 19, 2021

gdemonet Mar 19, 2021

gdemonet Mar 19, 2021

gdemonet Mar 19, 2021

gdemonet Mar 19, 2021

gdemonet Mar 19, 2021

gdemonet Mar 19, 2021

gdemonet Mar 19, 2021

gdemonet Mar 19, 2021

gdemonet left a comment

gdemonet Mar 22, 2021

JBWatenbergScality Mar 22, 2021

gdemonet Mar 22, 2021

gdemonet Mar 22, 2021

bert-e commented Mar 22, 2021

JBWatenbergScality commented Mar 22, 2021

bert-e commented Mar 22, 2021

bert-e commented Mar 22, 2021

	apiVersion: addons.metalk8s.scality.com
	apiVersion: addons.metalk8s.scality.com/v1alpha1

		Changing the MetalK8s UI Ingress Path
		""""""""""""""""""""""""""""""""""""""""""""""""

		MetalK8s UI Theme Customization
		~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

salt: Use csc framework for UI configuration #3181

salt: Use csc framework for UI configuration #3181

Conversation

JBWatenbergScality commented Mar 9, 2021 • edited Loading

JBWatenbergScality commented Mar 12, 2021

bert-e commented Mar 15, 2021

Hello jbwatenbergscality,

bert-e commented Mar 15, 2021

Waiting for approval

gdemonet left a comment

Choose a reason for hiding this comment

bert-e commented Mar 17, 2021

Waiting for approval

gdemonet left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gdemonet left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bert-e commented Mar 22, 2021

Waiting for approval

JBWatenbergScality commented Mar 22, 2021

bert-e commented Mar 22, 2021

In the queue

bert-e commented Mar 22, 2021

JBWatenbergScality commented Mar 9, 2021 •

edited

Loading