diff --git a/userdocs/fuel-user-guide/configure-environment/workflows.rst b/userdocs/fuel-user-guide/configure-environment/workflows.rst index 27e803005..f49b2cbfc 100644 --- a/userdocs/fuel-user-guide/configure-environment/workflows.rst +++ b/userdocs/fuel-user-guide/configure-environment/workflows.rst @@ -23,12 +23,12 @@ This section includes the following topics: :maxdepth: 1 workflows/workflows-overview.rst + workflows/workflows-precedence.rst workflows/workflows-create.rst workflows/workflows-data-driven.rst - workflows/workflows-run.rst .. seealso:: + - :ref:`workflows_manage` - :ref:`cli-graphs` - - :ref:`manage_workflows` - :ref:`data-driven` diff --git a/userdocs/fuel-user-guide/maintain-environment/manage-workflows/workflows-precedence.rst b/userdocs/fuel-user-guide/configure-environment/workflows/workflows-precedence.rst similarity index 100% rename from userdocs/fuel-user-guide/maintain-environment/manage-workflows/workflows-precedence.rst rename to userdocs/fuel-user-guide/configure-environment/workflows/workflows-precedence.rst diff --git a/userdocs/fuel-user-guide/configure-environment/workflows/workflows-run.rst b/userdocs/fuel-user-guide/configure-environment/workflows/workflows-run.rst deleted file mode 100644 index a70faa95d..000000000 --- a/userdocs/fuel-user-guide/configure-environment/workflows/workflows-run.rst +++ /dev/null @@ -1,112 +0,0 @@ - -.. _custom-graph: - -================== -Run a custom graph -================== - -You can execute a custom deployment graph and merge it with existing deployment -graphs of the upstream master release. - -This allows you to implement complex orchestrated workflows, such as -bugfixes application, reference architecture altering, or even upgrades. - -Each cluster has three classes of deployment graphs with the following -hierarchy listed in a descending order of importance: - -* Cluster-specific graph (most important). -* Graphs introduced by plugins -- These are the graphs of the enabled - plugins merged by the task ID. -* Release-default graph (least important). - -The custom graph may be of any particular type and is stored in the database -with this type. The default deployment graphs have the type ``default``. - -Each deployment run executes the deployment of a particular type -(``default`` by default). Fuel fetches the graphs of each of the three classes -for the corresponding type of deployment and merges the graphs by merging all -tasks by task IDs where high-level tasks override the lower ones. - -An example in the order of the graphs overriding: - -**Default deployment:** - -#. Release the default graph as derived from the tasks.yaml file of - fuel-library. -#. Plugins default graphs, which are ``deployment_tasks.yaml`` from plugins - manifests. -#. Cluster default grap, which is empty by default, with cluster-specific - tasks specified by the user - -The plugins graph merge order is not deterministic and it is supposed that -plugins graphs have no tasks intersections by task ID. - -**Custom-type graph:** - -#. Release custom-type graph, which is empty at this stage but can be derived - from the tasks.yaml file of fuel-library or be delivered by a maintenance - update. -#. Plugins custom-type graphs can be specified by plugin developers. -#. Cluster default grap, which is empty by default, with cluster-specific - tasks specified by the user - -To list a cluster-specific table with graphs, their relations, names, and -types: - -The graph ``name`` is an arbitrary parameter that defines additional -information about the graph. It has no impact on the business logic. - -#. Log in to the Fuel master node. -#. Run the following command: - - .. code-block:: console - - fuel2 graph list --env env_id - - where ``env_id`` is the ID of the environment. - -**To upload a graph:** - -#. Log in to the Fuel master node. -#. Run the following command: - - .. code-block:: console - - fuel2 graph upload --env env_id [--type graph_type] --file tasks.yaml - fuel2 graph upload --release release_id [--type graph_type] --file tasks.yaml - fuel2 graph upload --plugin plugin_id [--type graph_type] --file tasks.yaml - - where ``--type`` is an optional parameter. The ``default`` graph type with - confirmation should be used if no type is defined. - -The graphs downloaded with the keys ``--all`` and ``--plugins`` are the -result of other graphs merge performed by Nailgun and are not supposed to be -edited and uploaded back. -In most cases because they will completely override further changes made in -source graphs. - -**To download a graph:** - -#. Log in to the Fuel master node. -#. Run the following command: - - .. code-block:: console - - fuel2 graph download --env env_id --all [--type graph_type] [--file cluster_graph.yaml] - fuel2 graph download --env env_id --cluster [--type graph_type] [--file cluster_graph.yaml] - fuel2 graph download --env env_id --plugins [--type graph_type] [--file plugins_graph.yaml] - fuel2 graph download --env env_id --release [--type graph_type] [--file release_graph.yaml] - - where ``--type`` is an optional parameter. The command downloads the - ``default``if no type is defined. - -**To execute a graph:** - -#. Log in to the Fuel master node. -#. Run the following command: - - .. code-block:: console - - fuel2 graph execute --env env_id [--type graph_type] [--node node_ids] - -Graph execution is available only for the environment. \ No newline at end of file diff --git a/userdocs/fuel-user-guide/maintain-environment.rst b/userdocs/fuel-user-guide/maintain-environment.rst index ceacbb1a1..8bc8d6b86 100644 --- a/userdocs/fuel-user-guide/maintain-environment.rst +++ b/userdocs/fuel-user-guide/maintain-environment.rst @@ -22,6 +22,6 @@ This section includes the following topics: maintain-environment/reinstall-node.rst maintain-environment/reinstall-virtual-role.rst maintain-environment/create-snapshot.rst - maintain-environment/manage-workflows.rst + maintain-environment/workflows-manage.rst maintain-environment/shutdown-env.rst maintain-environment/start-env.rst diff --git a/userdocs/fuel-user-guide/maintain-environment/manage-workflows.rst b/userdocs/fuel-user-guide/maintain-environment/workflows-manage.rst similarity index 55% rename from userdocs/fuel-user-guide/maintain-environment/manage-workflows.rst rename to userdocs/fuel-user-guide/maintain-environment/workflows-manage.rst index d34e80053..02c06bf21 100644 --- a/userdocs/fuel-user-guide/maintain-environment/manage-workflows.rst +++ b/userdocs/fuel-user-guide/maintain-environment/workflows-manage.rst @@ -1,8 +1,8 @@ -.. _manage_workflows: +.. _workflows_manage: -=============== -Manage workfows -=============== +================ +Manage workflows +================ Fuel enables you to manage the deployment workflows through both the Fuel web UI and CLI. You can view, upload, download, and execute default workflows @@ -16,10 +16,15 @@ This section includes the following topics: .. toctree:: :maxdepth: 2 - manage-workflows/workflows-precedence.rst - manage-workflows/view-workflows.rst - manage-workflows/upload-workflows.rst - manage-workflows/download-workflows.rst - manage-workflows/run-workflows.rst - manage-workflows/view-history.rst - manage-workflows/download-deployment-info.rst \ No newline at end of file + workflows-manage/view-workflows.rst + workflows-manage/upload-workflows.rst + workflows-manage/download-workflows.rst + workflows-manage/run-workflows.rst + workflows-manage/view-history.rst + workflows-manage/download-deployment-info.rst + +.. seealso:: + + * :ref:`workflow-intro` + * :ref:`cli-graphs` + * :ref:`data-driven` \ No newline at end of file diff --git a/userdocs/fuel-user-guide/maintain-environment/manage-workflows/download-deployment-info.rst b/userdocs/fuel-user-guide/maintain-environment/workflows-manage/download-deployment-info.rst similarity index 100% rename from userdocs/fuel-user-guide/maintain-environment/manage-workflows/download-deployment-info.rst rename to userdocs/fuel-user-guide/maintain-environment/workflows-manage/download-deployment-info.rst diff --git a/userdocs/fuel-user-guide/maintain-environment/manage-workflows/download-workflows.rst b/userdocs/fuel-user-guide/maintain-environment/workflows-manage/download-workflows.rst similarity index 100% rename from userdocs/fuel-user-guide/maintain-environment/manage-workflows/download-workflows.rst rename to userdocs/fuel-user-guide/maintain-environment/workflows-manage/download-workflows.rst diff --git a/userdocs/fuel-user-guide/maintain-environment/manage-workflows/run-workflows.rst b/userdocs/fuel-user-guide/maintain-environment/workflows-manage/run-workflows.rst similarity index 100% rename from userdocs/fuel-user-guide/maintain-environment/manage-workflows/run-workflows.rst rename to userdocs/fuel-user-guide/maintain-environment/workflows-manage/run-workflows.rst diff --git a/userdocs/fuel-user-guide/maintain-environment/manage-workflows/upload-workflows.rst b/userdocs/fuel-user-guide/maintain-environment/workflows-manage/upload-workflows.rst similarity index 100% rename from userdocs/fuel-user-guide/maintain-environment/manage-workflows/upload-workflows.rst rename to userdocs/fuel-user-guide/maintain-environment/workflows-manage/upload-workflows.rst diff --git a/userdocs/fuel-user-guide/maintain-environment/manage-workflows/view-history.rst b/userdocs/fuel-user-guide/maintain-environment/workflows-manage/view-history.rst similarity index 100% rename from userdocs/fuel-user-guide/maintain-environment/manage-workflows/view-history.rst rename to userdocs/fuel-user-guide/maintain-environment/workflows-manage/view-history.rst diff --git a/userdocs/fuel-user-guide/maintain-environment/manage-workflows/view-workflows.rst b/userdocs/fuel-user-guide/maintain-environment/workflows-manage/view-workflows.rst similarity index 100% rename from userdocs/fuel-user-guide/maintain-environment/manage-workflows/view-workflows.rst rename to userdocs/fuel-user-guide/maintain-environment/workflows-manage/view-workflows.rst diff --git a/userdocs/release-notes/new_features.rst b/userdocs/release-notes/new_features.rst index a767ce5e0..a1c8413b9 100644 --- a/userdocs/release-notes/new_features.rst +++ b/userdocs/release-notes/new_features.rst @@ -42,7 +42,7 @@ This section lists these improvements: it with the existing deployment workflows of the upstream master release. This allows you to implement complex orchestrated workflows -- bugfixes application, reference architecture altering, or even upgrades. - See :ref:`manage_workflows`. + See :ref:`workflows_manage`. * Fuel now supports lifecycle management tasks based on the history of cluster states. This data-driven feature allows the deployment engineers