From 7f837ff17882d458b07423fbe1c5bab479e09eae Mon Sep 17 00:00:00 2001 From: Avital Pinnick Date: Tue, 13 Jul 2021 15:11:02 +0300 Subject: [PATCH] Add newer installation --- .../master.adoc | 9 ++- documentation/modules/about-pathfinder.adoc | 64 ----------------- documentation/modules/accessing-console.adoc | 25 +++++++ documentation/modules/console-services.adoc | 70 ++++++++++++++++++ .../modules/installing-application.adoc | 42 +++++++++++ .../modules/installing-operator.adoc | 42 +++++++++++ .../modules/installing-pathfinder.adoc | 72 ------------------- index.adoc | 2 +- 8 files changed, 188 insertions(+), 138 deletions(-) create mode 100644 documentation/modules/accessing-console.adoc create mode 100644 documentation/modules/console-services.adoc create mode 100644 documentation/modules/installing-application.adoc create mode 100644 documentation/modules/installing-operator.adoc delete mode 100644 documentation/modules/installing-pathfinder.adoc diff --git a/documentation/doc-installing-and-using-tackle/master.adoc b/documentation/doc-installing-and-using-tackle/master.adoc index 223af6e4..399866a9 100644 --- a/documentation/doc-installing-and-using-tackle/master.adoc +++ b/documentation/doc-installing-and-using-tackle/master.adoc @@ -17,7 +17,14 @@ include::modules/making-open-source-more-inclusive.adoc[] endif::[] include::modules/about-pathfinder.adoc[leveloffset=+1] -include::modules/installing-pathfinder.adoc[leveloffset=+1] + +[id="installing-pathfinder_{context}"] +== Installing {project-name} + +include::modules/installing-operator.adoc[leveloffset=+2] +include::modules/installing-application.adoc[leveloffset=+2] +include::modules/accessing-console.adoc[leveloffset=+2] +include::modules/console-services.adoc[leveloffset=+2] [id="managing-applications_{context}"] == Managing applications diff --git a/documentation/modules/about-pathfinder.adoc b/documentation/modules/about-pathfinder.adoc index 7bd7fa70..51214a5d 100644 --- a/documentation/modules/about-pathfinder.adoc +++ b/documentation/modules/about-pathfinder.adoc @@ -13,67 +13,3 @@ ifeval::["{build}" == "upstream"] endif::[] {project-name} uses an interactive questionnaire for the assessment. The assessment process enables key stakeholders to gather information about applications, to discuss risks flagged by {project-name}, and to reach a consensus in formulating recommendations for each application. - -{project-name} provides the following services in a web console: - -* Application inventory -* Assessments -* Reviews -* Reports -* Controls - -[id="application-inventory_{context}"] -== Application inventory - -The *Application inventory* page enables you to perform the following tasks: - -* Manage your application portfolio. -* Define and manage application dependencies. -* Link applications to the business services that they support. -* Describe and categorize applications by using tags. - -[id="assessments_{context}"] -== Assessments - -You can assess your applications on the *Application inventory* page. - -The assessment helps you determine an appropriate migration strategy for each application, for example, rehosting, replatforming, or refactoring. - -The assessment is an interactive questionnaire that gathers information and identifies possible risks and their severity. - -[id="reviews_{context}"] -== Reviews - -You can review a completed assessment on the *Application inventory* page. - -The following information is collected from each reviewer: - -* *Proposed action*: Proposed action for the application, for example, replatforming or rehosting. -* *Effort estimate*: How much effort is involved in migrating the application, based on the proposed action and the identified risks. -* *Business criticality*: How critical the application is to your business on a scale of `1` to `10`. -* *Work priority*: Your work priority estimate for the proposed action on a scale of `1` to `10`. - -The *Reports* page displays the results of the reviews. - -[id="reports_{context}"] -== Reports - -The *Reports* page displays the results of the application assessments and reviews and can help you to plan your migration. - -The reports provide information about the following: - -* Suitability of applications for containerization. -* Possible risks and severity. -* Adoption plan based on estimated effort, work priority, and application dependencies. - -[id="controls_{context}"] -== Controls - -The *Controls* page enables you to manage the following entities: - -* *Stakeholder*: A stakeholder is an individual with an interest in an application or a subject matter expert. -* *Stakeholder group*: A stakeholder group is a group of related stakeholders. A stakeholder can belong to one or more stakeholder groups. Stakeholder groups are used to assign multiple stakeholders to review an assessment. -* *Job function*: A job function is an attribute of a stakeholder. You use a predefined job function or create a new job function. -* *Business service*: A business service is an attribute of an application, for example, credit card service, transportation, or IT support. You can use a predefined business service or create a new business service. -* *Tag*: A tag is an attribute of an application. Tags are an extensible and flexible way to add metadata to applications. Tags are grouped under a parent tag type. You can use a predefined tag or create a new tag. -* *Tag type*: A tag type defines the rank and background color of a group of related tags. diff --git a/documentation/modules/accessing-console.adoc b/documentation/modules/accessing-console.adoc new file mode 100644 index 00000000..4c62be22 --- /dev/null +++ b/documentation/modules/accessing-console.adoc @@ -0,0 +1,25 @@ +// Module included in the following assemblies: +// +// * documentation/doc-installing-and-using-tackle/master.adoc + +[id="accessing-console_{context}"] += Logging in to the {project-name} web console + +You can log in to the {project-name} web console. + +.Prerequisites + +* The {project-name} application must be installed. +* You must have the route of the `tackle-ui` pod. This is the {project-name} web console URL. + +.Procedure + +. In a browser, navigate to the {project-name} web console. +. Enter `tackle` in the *Username or email* field, `password` in the *Password* field, and then click *Log in* to access the {project-name} web console. ++ +You can review the services of the {project-name} web console. + +[IMPORTANT] +==== +You must change the default password of the tackle user. +==== diff --git a/documentation/modules/console-services.adoc b/documentation/modules/console-services.adoc new file mode 100644 index 00000000..4ea60c37 --- /dev/null +++ b/documentation/modules/console-services.adoc @@ -0,0 +1,70 @@ +// Module included in the following assemblies: +// +// * documentation/doc-installing-and-using-tackle/master.adoc + +[id="console services_{context}"] += {project-name} web console services + +{project-name} web console provides the following services: + +* Application inventory +* Assessments +* Reviews +* Reports +* Controls + +[id="application-inventory_{context}"] +== Application inventory + +The *Application inventory* page enables you to perform the following tasks: + +* Manage your application portfolio. +* Define and manage application dependencies. +* Link applications to the business services that they support. +* Describe and categorize applications by using tags. + +[id="assessments_{context}"] +== Assessments + +You can assess your applications on the *Application inventory* page. + +The assessment helps you determine an appropriate migration strategy for each application, for example, rehosting, replatforming, or refactoring. + +The assessment is an interactive questionnaire that gathers information and identifies possible risks and their severity. + +[id="reviews_{context}"] +== Reviews + +You can review a completed assessment on the *Application inventory* page. + +The following information is collected from each reviewer: + +* *Proposed action*: Proposed action for the application, for example, replatforming or rehosting. +* *Effort estimate*: How much effort is involved in migrating the application, based on the proposed action and the identified risks. +* *Business criticality*: How critical the application is to your business on a scale of `1` to `10`. +* *Work priority*: Your work priority estimate for the proposed action on a scale of `1` to `10`. + +The *Reports* page displays the results of the reviews. + +[id="reports_{context}"] +== Reports + +The *Reports* page displays the results of the application assessments and reviews and can help you to plan your migration. + +The reports provide information about the following: + +* Suitability of applications for containerization. +* Possible risks and severity. +* Adoption plan based on estimated effort, work priority, and application dependencies. + +[id="controls_{context}"] +== Controls + +The *Controls* page enables you to manage the following entities: + +* *Stakeholder*: A stakeholder is an individual with an interest in an application or a subject matter expert. +* *Stakeholder group*: A stakeholder group is a group of related stakeholders. A stakeholder can belong to one or more stakeholder groups. Stakeholder groups are used to assign multiple stakeholders to review an assessment. +* *Job function*: A job function is an attribute of a stakeholder. You use a predefined job function or create a new job function. +* *Business service*: A business service is an attribute of an application, for example, credit card service, transportation, or IT support. You can use a predefined business service or create a new business service. +* *Tag*: A tag is an attribute of an application. Tags are an extensible and flexible way to add metadata to applications. Tags are grouped under a parent tag type. You can use a predefined tag or create a new tag. +* *Tag type*: A tag type defines the rank and background color of a group of related tags. diff --git a/documentation/modules/installing-application.adoc b/documentation/modules/installing-application.adoc new file mode 100644 index 00000000..ba806d32 --- /dev/null +++ b/documentation/modules/installing-application.adoc @@ -0,0 +1,42 @@ +// Module included in the following assemblies: +// +// * documentation/doc-installing-and-using-tackle/master.adoc + +[id="installing-application_{context}"] += Installing the {project-name} application + +ifeval::["{build}" == "downstream"] +Install the {project-name} application in a project by using the {ocp} web console. + +After you have installed the application, you can log in to the {project-name} web console. + +.Prerequisites + +* The {operator} must be installed on the cluster. +* You must have `project-admin-user` privileges. +* You must create a project for {project-name}. + +.Procedure + +. In the {ocp} web console, switch to the *Developer* perspective and click *+Add*. +. In the *Add* view, click *Operator Backed*. +. Click the *Tackle by Konveyor* tile. +. Click *Create*. +. Review the application settings and click *Create*. +. Click *Topology*. +. Click the *OpenURL* icon of the `tackle-ui` pod to open the {project-name} web console in a new browser window. +endif::[] +ifeval::["{build}" == "upstream"] +Install the {project-name} application in a project. + +.Prerequisites + +* The {operator} must be installed on the cluster. +* You must have `project-admin` privileges to install the {project-name} application in a project. +* You must create a project for {project-name}. + +.Procedure + +. Install the {project-name} application in a project by following the procedure for your enterprise Kubernetes platform. +. Obtain the route or URL of the `tackle-ui` pod to open the {project-name} web console in a new browser window. +endif::[] diff --git a/documentation/modules/installing-operator.adoc b/documentation/modules/installing-operator.adoc new file mode 100644 index 00000000..f8527200 --- /dev/null +++ b/documentation/modules/installing-operator.adoc @@ -0,0 +1,42 @@ +// Module included in the following assemblies: +// +// * documentation/doc-installing-and-using-tackle/master.adoc + +[id="installing-operator_{context}"] += Installing the {operator} + +ifeval::["{build}" == "downstream"] +[NOTE] +==== +The {operator} is a Community Operator. Red Hat provides no support for Community Operators. +==== + +Install the {operator} by using the OpenShift web console. + +.Prerequisites + +* You must have {ocp} 4 installed. +* You must have `cluster-admin` privileges. + +.Procedure + +. In the OpenShift Container Platform web console, click *Operators* -> *OperatorHub*. +. Click the *Modernization & Migration* category and then click the *{operator}* tile. +. Click *Install*. +. Select a project from the *Installed Namespace* list and click *Install*. +. After the {operator} is installed, click *View Operator* to verify the installation. +endif::[] +ifeval::["{build}" == "upstream"] +Download and install the {operator} from link:https://operatorhub.io[operatorhub.io]. + +.Prerequisites + +* You must have `admin` privileges to install the {operator}. + +.Procedure + +. Navigate to link:https://operatorhub.io[operatorhub.io]. +. Click the *Modernization & Migration* category. +. Click the *{operator}* tile and then click *Install*. +. Follow the installation instructions. +endif::[] diff --git a/documentation/modules/installing-pathfinder.adoc b/documentation/modules/installing-pathfinder.adoc deleted file mode 100644 index 638c4d9f..00000000 --- a/documentation/modules/installing-pathfinder.adoc +++ /dev/null @@ -1,72 +0,0 @@ -// Module included in the following assemblies: -// -// * documentation/doc-installing-and-using-tackle/master.adoc - -[id="installing-pathfinder_{context}"] -= Installing {project-name} - -You install the {operator} on the cluster and then install the {project-name} application in a project. - -ifeval::["{build}" == "downstream"] -[NOTE] -==== -The {operator} is a Community Operator. Red Hat provides no support for Community Operators. -==== - -[id="installing-operator_{context}"] -== Installing the Tackle Operator - -You install the {operator} by using the OpenShift web console. - -.Prerequisites - -* You must have {ocp} 4.7 or later installed. -* You must have `cluster-admin` privileges. - -.Procedure - -. In the OpenShift web console, click *Operators* -> *OperatorHub*. -. Click the *Modernization & Migration* category and then click the *{operator}* tile. -. Click *Install*. -. Select a project from the *Installed Namespace* list and click *Install*. -. After the {operator} is installed, click *View Operator* to verify the installation. - -[id="installing-application_{context}"] -== Installing the {project-name} application - -You install the {project-name} application in a project by using the OpenShift web console. - -After you have installed the application, you can log in to the {project-name} web console. - -.Prerequisites - -* The {operator} must be installed on the cluster. -* You must have `project-admin-user` privileges. -* You must create a project for {project-name}. - -.Procedure - -. In the OpenShift web console, switch to the *Developer* perspective and click *+Add*. -. In the *Add* view, click *Operator Backed*. -. Click the *Tackle by Konveyor* tile. -. Click *Create*. -. Review the application settings and click *Create*. -. Click *Topology*. -. Click the *OpenURL* icon of the `tackle-ui` pod to open the {project-name} application in a new browser window. -endif::[] -ifeval::["{build}" == "upstream"] -.Prerequisites - -* You must have `admin` privileges to install the {operator}. -* You must have `project-admin` privileges to install the {project-name} application in a project. - -.Procedure - -. Navigate to link:https://operatorhub.io[operatorhub.io]. -. Enter `Tackle` in the Search field to locate the {operator}. -. Click the *{operator}* tile and then click *Install*. -. Follow the installation instructions. -. Install the {project-name} application in a project by following the procedure for your enterprise Kubernetes platform. -. Obtain the route or URL of the `tackle-ui` pod to open the {project-name} application in a new browser window. -endif::[] -. Enter your *Username or email* and *Password* and then click *Log in* to access the {project-name} web console. diff --git a/index.adoc b/index.adoc index e583084a..a7526e13 100644 --- a/index.adoc +++ b/index.adoc @@ -8,4 +8,4 @@ Tackle is a tool in the link:https://konveyor.io/[Konveyor community] for refact ## Documentation -* link:documentation/doc-installing-and-using-tackle/master/index.html[Installing and using Tackle] (1.0 draft). GA: June 30, 2021. +* link:documentation/doc-installing-and-using-tackle/master/index.html[Installing and using Tackle] (1.0). Released June 30, 2021.