Skip to content

Commit a0b212e

Browse files
allaprischepaAlla Prishchepa
allaprischepa
and
Alla Prishchepa
authored
EPMRPP-104086 || Improve installation page (#586)
* EPMRPP-104086 || Improve installation page * EPMRPP-104086 || Improve installation page --------- Co-authored-by: Alla Prishchepa <[email protected]>
1 parent 1808587 commit a0b212e

File tree

2 files changed

+53
-104
lines changed

2 files changed

+53
-104
lines changed

‎src/containers/InstallationPage/DockerContent/DockerDeployingStep.tsx‎

Lines changed: 19 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,17 @@ import { Typography } from 'antd';
33
import { Link } from '@app/components/Link';
44
import { createBemBlockBuilder } from '@app/utils';
55

6-
import { Notice } from '../Notice';
7-
86
import '../InstallationPage.scss';
97

108
const DOCUMENTATION_URL = process.env.DOCUMENTATION_URL;
119

1210
export const DockerDeployingStep: FC = () => {
1311
const { Text } = Typography;
1412
const getBlocksWith = createBemBlockBuilder(['installation']);
13+
const dockerSnippet = `services:
14+
uat:
15+
environment:
16+
RP_INITIAL_ADMIN_PASSWORD: "YourSecurePass"`;
1517

1618
return (
1719
<>
@@ -35,56 +37,32 @@ export const DockerDeployingStep: FC = () => {
3537
https://raw.githubusercontent.com/reportportal/reportportal/master/docker-compose.yml
3638
</Text>
3739
<p>
38-
Ensure you override the UAT Service environment variable{' '}
39-
<span className={getBlocksWith('__code-text')}>RP_INITIAL_ADMIN_PASSWORD</span>
40+
Open <span className={getBlocksWith('__code-text')}>docker-compose.yml</span> and set a
41+
strong admin password:
4042
</p>
4143

44+
<Text className={getBlocksWith('__code')} code copyable>
45+
{dockerSnippet}
46+
</Text>
47+
4248
<p>2. Start the application using the following command:</p>
4349

4450
<Text className={getBlocksWith('__code')} code copyable>
4551
docker-compose -p reportportal up -d --force-recreate
4652
</Text>
4753

48-
<p>Where:</p>
49-
<p>
50-
<span className={getBlocksWith('__code-text')}>-p reportportal</span> — adds project
51-
prefix {"'reportportal'"} to all containers
52-
</p>
53-
<p>
54-
<span className={getBlocksWith('__code-text')}>up</span> — creates and starts containers
55-
</p>
5654
<p>
57-
<span className={getBlocksWith('__code-text')}>-d</span> — daemon mode
58-
</p>
59-
<p>
60-
{' '}
61-
<span className={getBlocksWith('__code-text')}>--force-recreate</span> — re-creates
62-
containers
55+
For detailed instructions, advanced configuration, backup/restore, and production
56+
recommendations, see the full guide:{' '}
57+
<Link
58+
className={getBlocksWith('__link')}
59+
to={`${DOCUMENTATION_URL}/installation-steps/DeployWithDocker/`}
60+
>
61+
How to deploy with Docker
62+
</Link>
63+
.
6364
</p>
6465
</div>
65-
66-
<Notice title="Useful commands">
67-
<span className={getBlocksWith('__code-text')}>docker-compose logs</span> — shows logs from
68-
all containers <br />
69-
<span className={getBlocksWith('__code-text')}>docker logs &lt;container_name&gt;</span> —
70-
shows logs from selected container <br />
71-
<p className={getBlocksWith('__code-text')}>
72-
docker ps -a | grep {'"reportportal_"'} | awk {"'{print $1}'"} | xargs <br />
73-
docker rm -f
74-
</p>{' '}
75-
<br />— deletes all ReportPortal containers
76-
</Notice>
77-
78-
<p>
79-
For a more comprehensive installation guide, please refer to the{' '}
80-
<Link
81-
className={getBlocksWith('__link')}
82-
to={`${DOCUMENTATION_URL}/installation-steps/DeployWithDocker/`}
83-
>
84-
link
85-
</Link>
86-
.
87-
</p>
8866
</>
8967
);
9068
};

‎src/containers/InstallationPage/DockerContent/DockerInstall.tsx‎

Lines changed: 34 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -1,81 +1,52 @@
11
import React, { FC } from 'react';
22
import { Link } from '@app/components/Link';
33
import { createBemBlockBuilder } from '@app/utils';
4+
import { Typography } from 'antd';
45

56
import { Notice } from '../Notice';
67

78
import '../InstallationPage.scss';
89

9-
const DOCUMENTATION_URL = process.env.DOCUMENTATION_URL;
10-
1110
export const DockerInstall: FC = () => {
1211
const getBlocksWith = createBemBlockBuilder(['installation']);
12+
const { Text } = Typography;
1313

1414
return (
1515
<div className={getBlocksWith('__wrapper')}>
1616
<h3 className={getBlocksWith('__title-content')}>Install Docker</h3>
17-
<p className={getBlocksWith('__text-content')}>
18-
<Link className={getBlocksWith('__link')} to="https://docs.docker.com/get-docker/">
19-
Download{' '}
20-
</Link>{' '}
21-
and install Docker. It’s supported by all major Linux distributions, MacOS and Windows.
22-
</p>
23-
24-
<Notice importance>
25-
<ul className={getBlocksWith('__list')}>
26-
<li>Recommended change resources limits at least 2 CPU 6 GB RAM for Docker</li>
27-
28-
<li>
29-
Desktop:{' '}
30-
<Link
31-
className={getBlocksWith('__link')}
32-
to="https://docs.docker.com/desktop/settings/mac"
33-
>
34-
MAC
35-
</Link>{' '}
36-
|
37-
<Link
38-
className={getBlocksWith('__link')}
39-
to="https://docs.docker.com/desktop/settings/windows/"
40-
>
41-
Windows
42-
</Link>{' '}
43-
|
44-
<Link
45-
className={getBlocksWith('__link')}
46-
to="https://docs.docker.com/desktop/settings/linux"
47-
>
48-
Linux
49-
</Link>
50-
</li>
51-
<li>We strongly recommend to deploy in Linux based environment</li>
52-
</ul>
53-
</Notice>
54-
55-
<Notice>
56-
For Windows users Docker requires 64-bit Windows 10 Pro (or higher) and Microsoft Hyper-V
57-
</Notice>
5817

59-
<p className={getBlocksWith('__text-content')}>
60-
Instead of using Docker for deployment you can follow the steps described{' '}
61-
<Link
62-
className={getBlocksWith('__link')}
63-
to={`${DOCUMENTATION_URL}/installation-steps/DeployWithoutDocker`}
64-
>
65-
here
66-
</Link>
67-
.
68-
</p>
69-
<p className={getBlocksWith('__text-content')}>
70-
Details about production deployment and system capacity are{' '}
71-
<Link
72-
className={getBlocksWith('__link')}
73-
to={`${DOCUMENTATION_URL}/installation-steps/OptimalPerformanceHardwareSetup/`}
74-
>
75-
here
76-
</Link>
77-
.
78-
</p>
18+
<h4>OS Support</h4>
19+
<ul className={getBlocksWith('__list')}>
20+
<li>
21+
<strong>Linux</strong> (Ubuntu 20.04+ or equivalent) - <em>Recommended</em>
22+
</li>
23+
<li>
24+
<strong>macOS</strong> (Intel or Apple Silicon; Docker Desktop requires macOS 12.0+)
25+
</li>
26+
<li>
27+
<strong>Windows</strong> (64-bit Windows 11 Pro+ with Hyper-V/WSL 2)
28+
</li>
29+
</ul>
30+
31+
<h4>Docker & Compose</h4>
32+
<ul className={getBlocksWith('__list')}>
33+
<li>
34+
Install{' '}
35+
<Link className={getBlocksWith('__link')} to="https://docs.docker.com/engine/install/">
36+
Docker Engine
37+
</Link>
38+
</li>
39+
<li>
40+
Ensure Docker Compose plugin is version ≥ 2.2{' '}
41+
<Text className={getBlocksWith('__code')} code copyable>
42+
docker compose version
43+
</Text>
44+
</li>
45+
</ul>
46+
47+
<h4>Resources</h4>
48+
49+
<Notice importance>Allocate ≥ 2 CPUs & 6 GB RAM to Docker; ≥ 20 GB free disk space</Notice>
7950
</div>
8051
);
8152
};

0 commit comments

Comments
 (0)