Skip to content
This repository was archived by the owner on Nov 21, 2025. It is now read-only.

Commit 5443eb2

Browse files
apinnickapinnick
authored
Merge pull request #39 from apinnick/sync-installation
Add newer installation
2 parents 5862842 + 28657ca commit 5443eb2

File tree

7 files changed

+187
-137
lines changed

7 files changed

+187
-137
lines changed

‎documentation/doc-installing-and-using-tackle/master.adoc‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,14 @@ include::modules/making-open-source-more-inclusive.adoc[]
1717
endif::[]
1818

1919
include::modules/about-pathfinder.adoc[leveloffset=+1]
20-
include::modules/installing-pathfinder.adoc[leveloffset=+1]
20+
21+
[id="installing-pathfinder_{context}"]
22+
== Installing {project-name}
23+
24+
include::modules/installing-operator.adoc[leveloffset=+2]
25+
include::modules/installing-application.adoc[leveloffset=+2]
26+
include::modules/accessing-console.adoc[leveloffset=+2]
27+
include::modules/console-services.adoc[leveloffset=+2]
2128

2229
[id="managing-applications_{context}"]
2330
== Managing applications

‎documentation/modules/about-pathfinder.adoc‎

Lines changed: 0 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -13,67 +13,3 @@ ifeval::["{build}" == "upstream"]
1313
endif::[]
1414

1515
{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.
16-
17-
{project-name} provides the following services in a web console:
18-
19-
* Application inventory
20-
* Assessments
21-
* Reviews
22-
* Reports
23-
* Controls
24-
25-
[id="application-inventory_{context}"]
26-
== Application inventory
27-
28-
The *Application inventory* page enables you to perform the following tasks:
29-
30-
* Manage your application portfolio.
31-
* Define and manage application dependencies.
32-
* Link applications to the business services that they support.
33-
* Describe and categorize applications by using tags.
34-
35-
[id="assessments_{context}"]
36-
== Assessments
37-
38-
You can assess your applications on the *Application inventory* page.
39-
40-
The assessment helps you determine an appropriate migration strategy for each application, for example, rehosting, replatforming, or refactoring.
41-
42-
The assessment is an interactive questionnaire that gathers information and identifies possible risks and their severity.
43-
44-
[id="reviews_{context}"]
45-
== Reviews
46-
47-
You can review a completed assessment on the *Application inventory* page.
48-
49-
The following information is collected from each reviewer:
50-
51-
* *Proposed action*: Proposed action for the application, for example, replatforming or rehosting.
52-
* *Effort estimate*: How much effort is involved in migrating the application, based on the proposed action and the identified risks.
53-
* *Business criticality*: How critical the application is to your business on a scale of `1` to `10`.
54-
* *Work priority*: Your work priority estimate for the proposed action on a scale of `1` to `10`.
55-
56-
The *Reports* page displays the results of the reviews.
57-
58-
[id="reports_{context}"]
59-
== Reports
60-
61-
The *Reports* page displays the results of the application assessments and reviews and can help you to plan your migration.
62-
63-
The reports provide information about the following:
64-
65-
* Suitability of applications for containerization.
66-
* Possible risks and severity.
67-
* Adoption plan based on estimated effort, work priority, and application dependencies.
68-
69-
[id="controls_{context}"]
70-
== Controls
71-
72-
The *Controls* page enables you to manage the following entities:
73-
74-
* *Stakeholder*: A stakeholder is an individual with an interest in an application or a subject matter expert.
75-
* *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.
76-
* *Job function*: A job function is an attribute of a stakeholder. You use a predefined job function or create a new job function.
77-
* *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.
78-
* *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.
79-
* *Tag type*: A tag type defines the rank and background color of a group of related tags.

‎documentation/modules/accessing-console.adoc‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * documentation/doc-installing-and-using-tackle/master.adoc
4+
5+
[id="accessing-console_{context}"]
6+
= Logging in to the {project-name} web console
7+
8+
You can log in to the {project-name} web console.
9+
10+
.Prerequisites
11+
12+
* The {project-name} application must be installed.
13+
* You must have the route of the `tackle-ui` pod. This is the {project-name} web console URL.
14+
15+
.Procedure
16+
17+
. In a browser, navigate to the {project-name} web console.
18+
. 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.
19+
+
20+
You can review the services of the {project-name} web console.
21+
22+
[IMPORTANT]
23+
====
24+
You must change the default password of the tackle user.
25+
====

‎documentation/modules/console-services.adoc‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * documentation/doc-installing-and-using-tackle/master.adoc
4+
5+
[id="console services_{context}"]
6+
= {project-name} web console services
7+
8+
{project-name} web console provides the following services:
9+
10+
* Application inventory
11+
* Assessments
12+
* Reviews
13+
* Reports
14+
* Controls
15+
16+
[id="application-inventory_{context}"]
17+
== Application inventory
18+
19+
The *Application inventory* page enables you to perform the following tasks:
20+
21+
* Manage your application portfolio.
22+
* Define and manage application dependencies.
23+
* Link applications to the business services that they support.
24+
* Describe and categorize applications by using tags.
25+
26+
[id="assessments_{context}"]
27+
== Assessments
28+
29+
You can assess your applications on the *Application inventory* page.
30+
31+
The assessment helps you determine an appropriate migration strategy for each application, for example, rehosting, replatforming, or refactoring.
32+
33+
The assessment is an interactive questionnaire that gathers information and identifies possible risks and their severity.
34+
35+
[id="reviews_{context}"]
36+
== Reviews
37+
38+
You can review a completed assessment on the *Application inventory* page.
39+
40+
The following information is collected from each reviewer:
41+
42+
* *Proposed action*: Proposed action for the application, for example, replatforming or rehosting.
43+
* *Effort estimate*: How much effort is involved in migrating the application, based on the proposed action and the identified risks.
44+
* *Business criticality*: How critical the application is to your business on a scale of `1` to `10`.
45+
* *Work priority*: Your work priority estimate for the proposed action on a scale of `1` to `10`.
46+
47+
The *Reports* page displays the results of the reviews.
48+
49+
[id="reports_{context}"]
50+
== Reports
51+
52+
The *Reports* page displays the results of the application assessments and reviews and can help you to plan your migration.
53+
54+
The reports provide information about the following:
55+
56+
* Suitability of applications for containerization.
57+
* Possible risks and severity.
58+
* Adoption plan based on estimated effort, work priority, and application dependencies.
59+
60+
[id="controls_{context}"]
61+
== Controls
62+
63+
The *Controls* page enables you to manage the following entities:
64+
65+
* *Stakeholder*: A stakeholder is an individual with an interest in an application or a subject matter expert.
66+
* *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.
67+
* *Job function*: A job function is an attribute of a stakeholder. You use a predefined job function or create a new job function.
68+
* *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.
69+
* *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.
70+
* *Tag type*: A tag type defines the rank and background color of a group of related tags.

‎documentation/modules/installing-application.adoc‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * documentation/doc-installing-and-using-tackle/master.adoc
4+
5+
[id="installing-application_{context}"]
6+
= Installing the {project-name} application
7+
8+
ifeval::["{build}" == "downstream"]
9+
Install the {project-name} application in a project by using the {ocp} web console.
10+
11+
After you have installed the application, you can log in to the {project-name} web console.
12+
13+
.Prerequisites
14+
15+
* The {operator} must be installed on the cluster.
16+
* You must have `project-admin-user` privileges.
17+
* You must create a project for {project-name}.
18+
19+
.Procedure
20+
21+
. In the {ocp} web console, switch to the *Developer* perspective and click *+Add*.
22+
. In the *Add* view, click *Operator Backed*.
23+
. Click the *Tackle by Konveyor* tile.
24+
. Click *Create*.
25+
. Review the application settings and click *Create*.
26+
. Click *Topology*.
27+
. Click the *OpenURL* icon of the `tackle-ui` pod to open the {project-name} web console in a new browser window.
28+
endif::[]
29+
ifeval::["{build}" == "upstream"]
30+
Install the {project-name} application in a project.
31+
32+
.Prerequisites
33+
34+
* The {operator} must be installed on the cluster.
35+
* You must have `project-admin` privileges to install the {project-name} application in a project.
36+
* You must create a project for {project-name}.
37+
38+
.Procedure
39+
40+
. Install the {project-name} application in a project by following the procedure for your enterprise Kubernetes platform.
41+
. Obtain the route or URL of the `tackle-ui` pod to open the {project-name} web console in a new browser window.
42+
endif::[]

‎documentation/modules/installing-operator.adoc‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * documentation/doc-installing-and-using-tackle/master.adoc
4+
5+
[id="installing-operator_{context}"]
6+
= Installing the {operator}
7+
8+
ifeval::["{build}" == "downstream"]
9+
[NOTE]
10+
====
11+
The {operator} is a Community Operator. Red Hat provides no support for Community Operators.
12+
====
13+
14+
Install the {operator} by using the OpenShift web console.
15+
16+
.Prerequisites
17+
18+
* You must have {ocp} 4 installed.
19+
* You must have `cluster-admin` privileges.
20+
21+
.Procedure
22+
23+
. In the OpenShift Container Platform web console, click *Operators* -> *OperatorHub*.
24+
. Click the *Modernization & Migration* category and then click the *{operator}* tile.
25+
. Click *Install*.
26+
. Select a project from the *Installed Namespace* list and click *Install*.
27+
. After the {operator} is installed, click *View Operator* to verify the installation.
28+
endif::[]
29+
ifeval::["{build}" == "upstream"]
30+
Download and install the {operator} from link:https://operatorhub.io[operatorhub.io].
31+
32+
.Prerequisites
33+
34+
* You must have `admin` privileges to install the {operator}.
35+
36+
.Procedure
37+
38+
. Navigate to link:https://operatorhub.io[operatorhub.io].
39+
. Click the *Modernization & Migration* category.
40+
. Click the *{operator}* tile and then click *Install*.
41+
. Follow the installation instructions.
42+
endif::[]

‎documentation/modules/installing-pathfinder.adoc‎

Lines changed: 0 additions & 72 deletions
This file was deleted.

0 commit comments

Comments
 (0)