docs: add documentation on the list of Cluster and Service Configuration #2291

Ebaneck · 2020-03-06T10:20:01Z

Component:

'docs'

Context:

See #2264

Summary:

Document the complete list of deployed cluster and service configurations

Acceptance criteria:

Closes: #2264

bert-e · 2020-03-06T10:20:04Z

Hello ebaneck,

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 · 2020-03-06T10:20:10Z

Integration data created

I have created the integration data for the additional destination branches.

this pull request will merge feature/2264-provide-documentation-on-list-of-cluster-service-configuration into
development/2.5
w/2.6/feature/2264-provide-documentation-on-list-of-cluster-service-configuration will be merged into development/2.6

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

You can set option create_pull_requests if you need me to create
integration pull requests in addition to integration branches, with:

@bert-e create_pull_requests

bert-e · 2020-03-06T10:20:12Z

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:

bert-e · 2020-03-06T10:27:03Z

History mismatch

Merge commit #bf2bedec611f13d971853d0d90343e86444c5e68 on the integration branch
w/2.6/feature/2264-provide-documentation-on-list-of-cluster-service-configuration is merging a branch which is neither the current
branch feature/2264-provide-documentation-on-list-of-cluster-service-configuration nor the development branch
development/2.6.

It is likely due to a rebase of the branch feature/2264-provide-documentation-on-list-of-cluster-service-configuration and the
merge is not possible until all related w/* branches are deleted or updated.

Please use the reset command to have me reinitialize these branches.

lucieleonard

Overall comment:
I would get rid of the titles inside, and the introduction (does not really provide information).
I would use what's written under "Managing Cluster and Services Configurations" as the topic intro.
And then, you present the table of parameters.
It would give:

Main title
<text on managing parameters/configuration>

docs/operation/cluster_and_service_configuration.rst

xaf-scality · 2020-03-12T13:58:37Z

docs/operation/cluster_and_service_configuration.rst

+
+      root@bootstrap $ crictl exec -it \
+                         $(crictl ps -q --label io.kubernetes.container.name=salt-master) bash
+


Why using crictl there and not kubectl ?

I think throughout the MetalK8s documentation, we have been using crictl to connect to the salt-master container. I think it is only fair that we stick to one for consistency

xaf-scality · 2020-03-12T14:00:22Z

docs/operation/cluster_and_service_configuration.rst

+
+      - Configuring LDAP
+      - Configuring Active Directory(AD)
+


Is it something that we can do from the GUI (create user, role ...) ?

I am afraid no for now. cc @thomasdanan

@xaf-scality UI configuration is tracked with #1991

xaf-scality · 2020-03-12T14:03:21Z

docs/operation/cluster_and_service_configuration.rst

+
+      root@bootstrap $ crictl exec -it \
+                         $(crictl ps -q --label io.kubernetes.container.name=salt-master) bash
+


same comment, why crictl and not kubectl ?

Ebaneck · 2020-03-13T09:04:18Z

/reset

bert-e · 2020-03-13T09:04:25Z

Reset complete

I have successfully deleted this pull request's integration branches.

bert-e · 2020-03-13T09:04:33Z

Integration data created

I have created the integration data for the additional destination branches.

this pull request will merge feature/2264-provide-documentation-on-list-of-cluster-service-configuration into
development/2.5
w/2.6/feature/2264-provide-documentation-on-list-of-cluster-service-configuration will be merged into development/2.6

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

You can set option create_pull_requests if you need me to create
integration pull requests in addition to integration branches, with:

@bert-e create_pull_requests

bert-e · 2020-03-13T09:04:35Z

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:

Ebaneck · 2020-03-13T11:11:57Z

/approve

Ebaneck · 2020-03-16T09:51:39Z

/reset

bert-e · 2020-03-16T09:51:46Z

Reset complete

I have successfully deleted this pull request's integration branches.

The following options are set: approve

bert-e · 2020-03-16T09:51:54Z

Integration data created

I have created the integration data for the additional destination branches.

this pull request will merge feature/2264-provide-documentation-on-list-of-cluster-service-configuration into
development/2.5
w/2.6/feature/2264-provide-documentation-on-list-of-cluster-service-configuration will be merged into development/2.6

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

You can set option create_pull_requests if you need me to create
integration pull requests in addition to integration branches, with:

@bert-e create_pull_requests

The following options are set: approve

bert-e · 2020-03-16T09:51:56Z

Build failed

The build for commit did not succeed in branch feature/2264-provide-documentation-on-list-of-cluster-service-configuration.

The following options are set: approve

bert-e · 2020-03-16T10:45:40Z

Build failed

The build for commit did not succeed in branch w/2.6/feature/2264-provide-documentation-on-list-of-cluster-service-configuration.

The following options are set: approve

bert-e · 2020-03-16T11:03:22Z

Build failed

The build for commit did not succeed in branch feature/2264-provide-documentation-on-list-of-cluster-service-configuration.

The following options are set: approve

bert-e · 2020-03-17T13:47:41Z

History mismatch

Merge commit #2165ecfe7d741f40500c51cbeeaf22576b03dbca on the integration branch
w/2.6/feature/2264-provide-documentation-on-list-of-cluster-service-configuration is merging a branch which is neither the current
branch feature/2264-provide-documentation-on-list-of-cluster-service-configuration nor the development branch
development/2.6.

It is likely due to a rebase of the branch feature/2264-provide-documentation-on-list-of-cluster-service-configuration and the
merge is not possible until all related w/* branches are deleted or updated.

Please use the reset command to have me reinitialize these branches.

The following options are set: approve

Ebaneck · 2020-03-17T13:48:11Z

/reset

bert-e · 2020-03-17T13:48:18Z

Reset complete

I have successfully deleted this pull request's integration branches.

The following options are set: approve

bert-e · 2020-03-17T13:48:26Z

Integration data created

I have created the integration data for the additional destination branches.

this pull request will merge feature/2264-provide-documentation-on-list-of-cluster-service-configuration into
development/2.5
w/2.6/feature/2264-provide-documentation-on-list-of-cluster-service-configuration will be merged into development/2.6

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

You can set option create_pull_requests if you need me to create
integration pull requests in addition to integration branches, with:

@bert-e create_pull_requests

The following options are set: approve

bert-e · 2020-03-17T13:48:28Z

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: approve

bert-e · 2020-03-17T14:44:09Z

Build failed

The build for commit did not succeed in branch w/2.6/feature/2264-provide-documentation-on-list-of-cluster-service-configuration.

The following options are set: approve

bert-e · 2020-03-18T12:20:53Z

History mismatch

Merge commit #75c3632fc831f0a8075079f042f95deb08e0e391 on the integration branch
w/2.6/feature/2264-provide-documentation-on-list-of-cluster-service-configuration is merging a branch which is neither the current
branch feature/2264-provide-documentation-on-list-of-cluster-service-configuration nor the development branch
development/2.6.

It is likely due to a rebase of the branch feature/2264-provide-documentation-on-list-of-cluster-service-configuration and the
merge is not possible until all related w/* branches are deleted or updated.

Please use the reset command to have me reinitialize these branches.

The following options are set: approve

This PR adds doc on the list of available Cluster and Service Configurations deployed by default in a MetalK8s cluster Closes: #2264

Ebaneck · 2020-03-18T12:22:28Z

/reset

bert-e · 2020-03-18T12:22:35Z

Reset complete

I have successfully deleted this pull request's integration branches.

The following options are set: approve

bert-e · 2020-03-18T12:22:43Z

Integration data created

I have created the integration data for the additional destination branches.

this pull request will merge feature/2264-provide-documentation-on-list-of-cluster-service-configuration into
development/2.5
w/2.6/feature/2264-provide-documentation-on-list-of-cluster-service-configuration will be merged into development/2.6

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

You can set option create_pull_requests if you need me to create
integration pull requests in addition to integration branches, with:

@bert-e create_pull_requests

The following options are set: approve

bert-e · 2020-03-18T12:22:44Z

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: approve

bert-e · 2020-03-18T15:40:48Z

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.5
✔️ development/2.6

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

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

bert-e · 2020-03-18T16:39:56Z

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

✔️ development/2.5
✔️ development/2.6

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

Please check the status of the associated issue None.

Goodbye ebaneck.

Ebaneck requested review from lucieleonard and a team March 6, 2020 10:20

Ebaneck force-pushed the feature/2264-provide-documentation-on-list-of-cluster-service-configuration branch from bf2bede to 944c5fa Compare March 6, 2020 10:26

lucieleonard reviewed Mar 6, 2020

View reviewed changes

Ebaneck requested a review from thomasdanan March 6, 2020 15:27

Ebaneck force-pushed the feature/2264-provide-documentation-on-list-of-cluster-service-configuration branch 4 times, most recently from e990e26 to 0abe961 Compare March 9, 2020 16:25

Ebaneck requested a review from gdemonet March 9, 2020 17:12

Ebaneck force-pushed the feature/2264-provide-documentation-on-list-of-cluster-service-configuration branch from 0abe961 to 594254f Compare March 10, 2020 08:46

thomasdanan reviewed Mar 11, 2020

View reviewed changes

Ebaneck marked this pull request as ready for review March 11, 2020 15:08

Ebaneck requested review from thomasdanan and lucieleonard March 11, 2020 15:08

TeddyAndrieux reviewed Mar 12, 2020

View reviewed changes

docs/operation/cluster_and_service_configuration.rst Outdated Show resolved Hide resolved

TeddyAndrieux reviewed Mar 12, 2020

View reviewed changes

docs/operation/cluster_and_service_configuration.rst Show resolved Hide resolved

Ebaneck requested a review from TeddyAndrieux March 12, 2020 10:04

xaf-scality reviewed Mar 12, 2020

View reviewed changes

Ebaneck force-pushed the feature/2264-provide-documentation-on-list-of-cluster-service-configuration branch from 44d8c44 to 2165ecf Compare March 13, 2020 01:15

thomasdanan previously approved these changes Mar 13, 2020

View reviewed changes

scality deleted a comment from bert-e Mar 16, 2020

Ebaneck dismissed thomasdanan’s stale review via 75c3632 March 17, 2020 13:47

Ebaneck force-pushed the feature/2264-provide-documentation-on-list-of-cluster-service-configuration branch from 2165ecf to 75c3632 Compare March 17, 2020 13:47

thomasdanan previously approved these changes Mar 17, 2020

View reviewed changes

Ebaneck dismissed thomasdanan’s stale review via 1a694e9 March 18, 2020 12:20

Ebaneck force-pushed the feature/2264-provide-documentation-on-list-of-cluster-service-configuration branch from 75c3632 to 1a694e9 Compare March 18, 2020 12:20

docs: add documentation on the list of Cluster and Service Configuration

1a694e9

This PR adds doc on the list of available Cluster and Service Configurations deployed by default in a MetalK8s cluster Closes: #2264

thomasdanan approved these changes Mar 18, 2020

View reviewed changes

bert-e merged commit 7442b27 into development/2.5 Mar 18, 2020

bert-e deleted the feature/2264-provide-documentation-on-list-of-cluster-service-configuration branch March 18, 2020 16:40


		root@bootstrap $ crictl exec -it \
		$(crictl ps -q --label io.kubernetes.container.name=salt-master) bash

docs: add documentation on the list of Cluster and Service Configuration #2291

docs: add documentation on the list of Cluster and Service Configuration #2291

Conversation

Ebaneck commented Mar 6, 2020

bert-e commented Mar 6, 2020

Hello ebaneck,

bert-e commented Mar 6, 2020

Integration data created

bert-e commented Mar 6, 2020

Waiting for approval

bert-e commented Mar 6, 2020

History mismatch

lucieleonard left a comment • edited Loading

Choose a reason for hiding this comment

xaf-scality Mar 12, 2020

Choose a reason for hiding this comment

Ebaneck Mar 12, 2020

Choose a reason for hiding this comment

xaf-scality Mar 12, 2020

Choose a reason for hiding this comment

Ebaneck Mar 12, 2020 • edited Loading

Choose a reason for hiding this comment

thomasdanan Mar 13, 2020

Choose a reason for hiding this comment

xaf-scality Mar 12, 2020

Choose a reason for hiding this comment

Ebaneck commented Mar 13, 2020

bert-e commented Mar 13, 2020

Reset complete

bert-e commented Mar 13, 2020

Integration data created

bert-e commented Mar 13, 2020

Waiting for approval

Ebaneck commented Mar 13, 2020

Ebaneck commented Mar 16, 2020

bert-e commented Mar 16, 2020

Reset complete

bert-e commented Mar 16, 2020

Integration data created

bert-e commented Mar 16, 2020

Build failed

bert-e commented Mar 16, 2020

Build failed

bert-e commented Mar 16, 2020

Build failed

bert-e commented Mar 17, 2020

History mismatch

Ebaneck commented Mar 17, 2020

bert-e commented Mar 17, 2020

Reset complete

bert-e commented Mar 17, 2020

Integration data created

bert-e commented Mar 17, 2020

Waiting for approval

bert-e commented Mar 17, 2020

Build failed

bert-e commented Mar 18, 2020

History mismatch

Ebaneck commented Mar 18, 2020

bert-e commented Mar 18, 2020

Reset complete

bert-e commented Mar 18, 2020

Integration data created

bert-e commented Mar 18, 2020

Waiting for approval

bert-e commented Mar 18, 2020

In the queue

bert-e commented Mar 18, 2020

lucieleonard left a comment •

edited

Loading

Ebaneck Mar 12, 2020 •

edited

Loading