Skip to content

Commit 8a1f7f0

Browse files
committed
docs(getting-started): Beginning update
1 parent fec3645 commit 8a1f7f0

File tree

1 file changed

+18
-19
lines changed

1 file changed

+18
-19
lines changed

docs/getting_started.md

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,27 @@
11
# Getting started
22

3-
!!! info "Pre-Requisites"
4-
5-
**In order to follow this tutorial, you will need several elements ready on
6-
the target server:
7-
- A compatible processor
8-
- A python installation ready
9-
- Docker & Docker-Compose ready
10-
- Root access**
11-
12-
!!! warning "Testing purpose tutorial"
13-
14-
This quick Getting-Started will guide you to get a quick view of PowerAPI
15-
capabilities.
16-
To do so in a light way, **the final output displayed is not the
17-
intended use of the tools for an everyday deployment**, you'll only get quick & concise
18-
statistics on the tested period.
3+
In this tutorial, we will guide you through the first steps to get started with PowerAPI.
4+
The objective is to get a quick view of the capabilities of PowerAPI, by monitoring a process and getting a quick glimpse at the energy consumption.
5+
A few things are required before we start :
6+
7+
- A compatible processor, you can see the compatible CPU architecture [here](./reference/sensors/hwpc-sensor.md#) and you can look on the following pages to find your CPU architecture :
8+
- For [Intel Processor](https://en.wikipedia.org/wiki/List_of_Intel_processors)
9+
- For [Intel Xeon Processor](https://en.wikipedia.org/wiki/List_of_Intel_Xeon_processors)
10+
- For [AMD Processor](https://en.wikipedia.org/wiki/Table_of_AMD_processors)
11+
12+
- A python installation ready
13+
- Docker & Docker-Compose ready
14+
- Root access
15+
16+
The first step of the tutorial will be to define the elements to monitor.
17+
In the testing archive, we will be able to see the consumption of the docker container by the default.
18+
So feel free to skip directly to the [preparation part](#preparation) if you don't want to monitor a specific process.
1919

2020
## Define elements to monitor
2121

2222
PowerAPI being a monitoring tool for energy consumption, we will need to define
23-
the necessary elements to monitor.
24-
In the testing archive, we will be able to see the consumption of the docker container by the default.
25-
But if we want to monitor a specific process, we can use the Linux abstraction of [cGroups](https://www.redhat.com/sysadmin/cgroups-part-one).
23+
the necessary elements to monitor.
24+
To do so we can use the Linux abstraction of [cGroups](https://www.redhat.com/sysadmin/cgroups-part-one).
2625

2726
### Create a cGroup
2827

0 commit comments

Comments
 (0)