Skip to content

Commit

Permalink
docs: update solutions doc to remove UI deployment part
Browse files Browse the repository at this point in the history
Update architecture document and solution developer
guide to remove the part related to the deployment
of Solution UIs because we no longer deploy them.

Refs: #2581
  • Loading branch information
alexandre-allard committed Aug 12, 2020
1 parent f9233b1 commit 56a6742
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 26 deletions.
16 changes: 4 additions & 12 deletions docs/developer/architecture/solutions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -135,10 +135,6 @@ the root of the archive, with the following format::
image:
name: solution-name-operator
tag: 1.0.0
ui:
image:
name: solution-name-ui
tag: 1.0.0
version: 1.0.0

This manifest will be read by a Salt external pillar module,
Expand Down Expand Up @@ -170,10 +166,6 @@ The external pillar will be structured as follows::
image:
name: solution-name-operator
tag: 1.0.0
ui:
image:
name: solution-name-ui
tag: 1.0.0
version: 1.0.0
id: solution-name-1.0.0
mountpoint: /srv/scality/solution-name-1.0.0
Expand Down Expand Up @@ -288,7 +280,7 @@ versions, on the same cluster, without collision between them.
Each namespace in an environment will have a :term:`ConfigMap`
``metalk8s-environment`` deployed which will describe what an environment is
composed of (Solutions and versions). This :term:`ConfigMap` will then be
consumed by Salt to deploy Solutions Operators and UIs.
consumed by Salt to deploy Solutions Operators.

This :term:`ConfigMap` will be structured as follows::

Expand All @@ -301,8 +293,8 @@ This :term:`ConfigMap` will be structured as follows::
<solution-x-name>: <solution-x-version>
<solution-y-name>: <solution-y-version>

``Environments`` will be created by a CLI tool or through the Solution UI
(both should be available), prior to deploy Solutions.
``Environments`` will be created by a CLI tool or through the MetalK8s
Environment page (both should be available), prior to deploy Solutions.

Solution management
~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -330,7 +322,7 @@ Solution does, but with the need of an extra container with almost full access
to the Kubernetes cluster and that’s the reason why we did choose to not use
it.

We also want to enforce some practices (Operator, UI, ...) in Solutions
We also want to enforce some practices (Operator pattern) in Solutions
and this is not easily doable using it.

Moreover, CNAB_ is a pretty young project and has not yet been adopted by a
Expand Down
9 changes: 0 additions & 9 deletions docs/developer/solutions/archive.rst
Original file line number Diff line number Diff line change
Expand Up @@ -103,17 +103,8 @@ It must respect the following format (currently
image:
name: solution-name-operator
tag: 1.0.0
ui:
image:
name: solution-name-ui
tag: 1.0.0
version: 1.0.0

.. note:: `spec.ui` is an optional key to let MetalK8s handle the deployment
of the Solution UI. This mechanism is deprecated and will be removed
in later versions. The Operator will need to handle the
deployment and lifecycle of the UI.

It is recommended for inspection purposes to include some annotations related
to the build-time conditions, such as the following (where command invocations
should be statically replaced in the generated ``manifest.yaml``)::
Expand Down
2 changes: 1 addition & 1 deletion docs/developer/solutions/deploy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ to only delete a single Namespace, using:
Add a Solution in an Environment
--------------------------------

Adding a Solution will deploy its UI and Operator resources in the Environment.
Adding a Solution will deploy its Operator in the Environment.

To add a Solution in an Environment, use the ``add-solution`` subcommand:

Expand Down
7 changes: 3 additions & 4 deletions docs/developer/solutions/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ details in :doc:`./archive`), and to discover it at import time.

Note that Solutions are **imported** based on this file contents, i.e.
the images they contain are made available in the registry and the Operator
and the UI are deployed, however **deploying** subsequent application(s)
is deployed, however **deploying** subsequent application(s)
is left to the user, through manual operations or the Solution UI.

.. note::
Expand All @@ -85,7 +85,7 @@ MetalK8s
**MUST**:

- Handle reading and mounting of the Solution ISO archive
- Provide tooling to deploy/upgrade a Solution's CRDs, Operator and UI
- Provide tooling to deploy/upgrade a Solution's CRDs and Operator

**MAY**:

Expand All @@ -99,8 +99,7 @@ Solution

- Comply with the standard archive structure defined by MetalK8s
- If providing a UI, expose management of its Operator instances
- Handle monitoring of its own services (both Operator and application, except
the UI)
- Handle monitoring of its own services (both Operator and application)

**SHOULD**:

Expand Down

0 comments on commit 56a6742

Please sign in to comment.