Skip to content

Commit 41eea09

Browse files
Content changes to tidal.cloud (#261)
* Content changes * Apply review suggestion changes
1 parent 6efabbd commit 41eea09

File tree

9 files changed

+92
-91
lines changed

9 files changed

+92
-91
lines changed

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2019 Tidal Migrations
3+
Copyright (c) 2023 Tidal
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,12 @@
11
# Machine Stats
22

33
A simple and effective way to gather machine statistics (RAM, Storage, CPU)
4-
from a server environment as a first layer of a [Tidal Migrations discovery
5-
process](https://guides.tidalmg.com).
4+
from a server environment as a first layer of a [Tidal discovery process](https://guides.tidal.cloud/).
65

76
Supports Windows and Unix-like platforms.
87

98
> _NB: For other platforms or custom integrations, see [the guides
10-
> here](https://guides.tidalmg.com/sync-servers.html)._
9+
> here](https://guides.tidal.cloud/sync-servers.html)._
1110
1211
## Overview
1312

@@ -24,20 +23,21 @@ trickery of thin-provisioning from SAN tools. This allows you to confidently
2423
plan data replication time, or other migration metrics on an app-by-app basis.
2524

2625
```
27-
┌ Machine Stats ─────────────┐ ╔═ T I D A L M I G R A T I O N S ════╗
28-
│ │ ║
29-
│ CPU, RAM, Storage etc. │ ║ - Single Source of Truth
30-
│ │ `tidal sync servers` ║ - Server, Database, and
31-
│ │──────────────────────────>║ Application Inventory
32-
│ │ ║
33-
│ │ ║
34-
└────────────────────────────┘ ╚═══════════════════════════════════════
26+
┌ Machine Stats ─────────────┐ ╔═════════ TIDAL CLOUD ═════════╗
27+
│ │ ║ ║
28+
│ CPU, RAM, Storage etc. │ ║ - Single Source of Truth ║
29+
│ │ `tidal sync servers` ║ - Server, Database, and ║
30+
│ │──────────────────────────>║ Application Inventory ║
31+
│ │ ║ ║
32+
│ │ ║ ║
33+
└────────────────────────────┘ ╚═══════════════════════════════╝
3534
```
3635

3736
As your cloud migration will likely take place over many months or years, it's
3837
important to have current resource requirements throughout your journey. To
3938
accomplish this, setup `machine_stats` in a cron job or Scheduled Task and
40-
synchronize your data on a _daily_ basis to Tidal Migrations.
39+
synchronize your data on a _daily_ basis to Tidal. You can find more information
40+
about it [here](https://guides.tidal.cloud/machine_stats.html#run-machine-stats-on-a-cron-job).
4141

4242
## Table of Contents
4343

SECURITY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Reporting vulnerabilities
22

3-
If you think you've identified a security related issue, please email us at security@tidalmigrations.com. This is delivered directly to our engineering and security team. Your email will be acknowledged within one business day, and you'll receive a more detailed response to your email within 7 days indicating the next steps in handling your report.
3+
If you think you've identified a security related issue, please email us at <security@tidalcloud.com>. This is delivered directly to our engineering and security team. Your email will be acknowledged within one business day, and you'll receive a more detailed response to your email within 7 days indicating the next steps in handling your report.
44

55
In addition, please include the following information along with your report:
66

libvirt/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Machine Stats for Hypervisors (Virt-Stats)
22

3-
A simple and effective way to gather guest VM statistics (hostname, IP addresses) from a [libvirt](https://libvirt.org/)-based environment as a first layer of a [Tidal Migrations discovery process](https://guides.tidalmg.com/). A common use case is to use this to integrate your KVM-based virtual machine inventory into the Tidal Migrations Platform.
3+
A simple and effective way to gather guest VM statistics (hostname, IP addresses) from a [libvirt](https://libvirt.org/)-based environment as a first layer of a [Tidal's discovery process](https://guides.tidal.cloud/). A common use case is to use this to integrate your KVM-based virtual machine inventory into the [Tidal Accelerator](https://www.tidalcloud.com/accelerator/) Platform.
44

55
## Prerequisutes
66

libvirt/setup.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
setup(
77
name="virt_stats",
88
version="develop",
9-
author="Tidal Migrations",
10-
author_email="support@tidalmigrations.com",
9+
author="Tidal",
10+
author_email="support@tidalcloud.com",
1111
description="A simple and effective way to gather machine statistics (RAM, Storage, CPU, etc.) from virtual environment",
1212
long_description=long_description,
1313
long_description_content_type="text/markdown",

unix/README.md

Lines changed: 50 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,22 @@
33
[![PyPI](https://img.shields.io/pypi/v/machine-stats)](https://pypi.org/project/machine-stats/)
44

55
A simple and effective way to gather machine statistics (RAM, Storage, CPU)
6-
from a server environment as a first layer of a [Tidal Migrations discovery
7-
process](https://guides.tidalmg.com).
6+
from a server environment as a first layer of a [Tidal discovery process](https://guides.tidal.cloud/).
87

98
Machine Stats for Linux/Unix leverages [Ansible](https://www.ansible.com/) to
109
gather facts in a cross-platform way.
1110

1211
## Interactive tutorial
1312

14-
Get familiar with Machine Stats, Tidal Tools and Tidal Migrations Platform!
13+
Get familiar with Machine Stats, Tidal Tools and Tidal Accelerator!
1514

1615
[![Open in Cloud Shell](https://gstatic.com/cloudssh/images/open-btn.svg)](https://ssh.cloud.google.com/cloudshell/editor?cloudshell_git_repo=https%3A%2F%2Fgithub.com%2Ftidalmigrations%2Fmachine-stats-workshop&cloudshell_image=gcr.io%2Ftidal-1529434400027%2Fmachine-stats-workshop&cloudshell_tutorial=machine-stats.md&shellonly=true)
1716

1817
## Installation
1918

2019
Install locally in a Python 3 environment:
2120

22-
```
21+
```sh
2322
python3 -m pip install machine-stats
2423
```
2524

@@ -31,85 +30,85 @@ _Need to install in an environment without internet access?_ [Checkout how to do
3130
### Ubuntu 16.04
3231

3332
1. Make sure `pip` is installed and is one of the latest version available:
34-
```
33+
```sh
3534
sudo apt update && \
3635
sudo apt install -y python3-pip && \
3736
python3 -m pip install --user pip==18.1 && \
3837
python3 -m pip install --upgrade --user pip
3938
```
4039
**Note:** Direct upgrade to the latest available `pip` version results with an unusable `pip` installation. That's why we perform the upgrade through the intermediate version (`18.1`).
4140
2. Install `machine-stats`:
42-
```
41+
```sh
4342
python3 -m pip install machine-stats
4443
```
4544
4645
### Debian 9/Ubuntu 18.04
4746
4847
1. Make sure `pip` is installed and is one of the latest version:
49-
```
48+
```sh
5049
sudo apt update && \
5150
sudo apt install -y python3-pip && \
5251
python3 -m pip install --upgrade pip
5352
```
5453
2. Install `machine-stats`:
55-
```
54+
```sh
5655
python3 -m pip install machine-stats
5756
```
5857
5958
### Debian 10/Debian 11/Ubuntu 20.04/Ubuntu 21.04
6059
6160
1. Make sure `pip` is installed:
62-
```
61+
```sh
6362
sudo apt update && \
6463
sudo apt install -y python3-pip
6564
```
6665
2. Install `machine-stats`:
67-
```
66+
```sh
6867
python3 -m pip install machine-stats
6968
```
7069
7170
### CentOS 7/CentOS 8/CentOS Stream/Red Hat Enterprise Linux 7/Red Hat Enterprise Linux 8/Rocky Linux 8
7271
7372
1. Install Python 3:
74-
```
73+
```sh
7574
sudo yum install -y python3
7675
```
7776
2. Upgrade `pip` to the latest available version:
78-
```
77+
```sh
7978
python3 -m pip install --upgrade --user pip
8079
```
8180
3. Install `machine-stats`:
82-
```
81+
```sh
8382
python3 -m pip install machine-stats
8483
```
8584
8685
### SUSE Linux Enterprise Server 12
8786
8887
1. Install Python 3.6:
89-
```
88+
```sh
9089
sudo zypper install -y python36-base
9190
```
9291
2. Install `machine-stats`:
93-
```
92+
```sh
9493
pip install machine-stats
9594
```
9695
9796
### SUSE Linux Enterprise Server 15
9897
9998
1. Install `pip`:
100-
```
99+
```sh
101100
sudo zypper install -y python3-pip
102101
```
103102
2. Install `machine-stats`:
104-
```
103+
```sh
105104
pip install machine-stats
106105
```
107106
</details>
108107
109108
## Data captured
110109
111110
For Linux/Unix based systems, by default, the following metrics are captured
112-
from the resources and sent and stored in Tidal Migrations:
111+
from the resources and sent and stored in Tidal Accelerator:
113112
114113
- Host Name
115114
- FQDN
@@ -133,7 +132,7 @@ You also can optionally capture metrics about processes running on the server:
133132
- Total Alive Time
134133
135134
To enable capturing process metrics add the command-line flag `--process-stats`:
136-
```
135+
```sh
137136
machine-stats --process-stats
138137
```
139138
@@ -148,7 +147,7 @@ machine-stats --process-stats
148147
3. If you need to use a custom SSH identity file for some particular host,
149148
provide it as the following:
150149
151-
```
150+
```sh
152151
my-user@example.com ansible_ssh_private_key_file=path/to/key-file.pem
153152
```
154153
@@ -157,14 +156,14 @@ machine-stats --process-stats
157156
`/usr/bin/python`), add the `ansible_python_interpreter` parameter to the
158157
`hosts` file after the host IP/domain, for example:
159158
160-
```
159+
```text
161160
freebsd.example.com ansible_python_interpreter=/usr/local/bin/python
162161
```
163162
164163
6. Execute `machine-stats` and pipe its output to Tidal Tools:
165164
166-
```
167-
$ machine-stats | tidal sync servers
165+
```sh
166+
machine-stats | tidal sync servers
168167
```
169168
170169
### Additional notes
@@ -173,14 +172,14 @@ By default Machine Stats looks for the `hosts` file in current working
173172
directory. If your inventory file has another name or is located on another
174173
path, then you should specify it explicitly:
175174
176-
```
177-
$ machine-stats /path/to/myhosts | tidal sync servers
175+
```sh
176+
machine-stats /path/to/myhosts | tidal sync servers
178177
```
179178
180179
You can specify multiple inventory files as the following:
181180
182-
```
183-
$ machine-stats hosts myhosts /path/to/myhosts
181+
```sh
182+
machine-stats hosts myhosts /path/to/myhosts
184183
```
185184
186185
### Configuration
@@ -203,8 +202,8 @@ configuration files in the following locations:
203202
Also, it is possible to specify the custom configuration file location by
204203
setting the `ANSIBLE_CONFIG` environment variable, for example:
205204
206-
```
207-
$ ANSIBLE_CONFIG=/path/to/my/machine_stats.cfg machine_stats /path/to/my/hosts
205+
```sh
206+
ANSIBLE_CONFIG=/path/to/my/machine_stats.cfg machine_stats /path/to/my/hosts
208207
```
209208
210209
**Note:** if `ANSIBLE_CONFIG` value points to a directory, then Machine Stats
@@ -220,19 +219,19 @@ but installs Python 2.6 alongside with system Python packages.
220219
1. Download Python 2.6 package and its dependencies from EPEL repository:
221220

222221
```console
223-
$ sudo curl -L -OOO -k \
222+
sudo curl -L -OOO -k \
224223
http://download.fedoraproject.org/pub/archive/epel/5/x86_64/{python26-libs-2.6.8-2.el5.x86_64.rpm,libffi-3.0.5-1.el5.x86_64.rpm,python26-2.6.8-2.el5.x86_64.rpm}
225224
```
226225

227226
2. Install the packages:
228227

229228
```console
230-
$ sudo rpm -ivh python26*.rpm libffi*.rpm
229+
sudo rpm -ivh python26*.rpm libffi*.rpm
231230
```
232231

233232
3. Use non-standard Python location in your `hosts` file:
234233

235-
```
234+
```text
236235
my-user@rhel5.example.com ansible_python_interpreter=/usr/bin/python2.6
237236
```
238237

@@ -245,45 +244,45 @@ Python versions.
245244
1. On the machine with internet connection create the packages archive using
246245
the following commands:
247246

248-
```console
249-
$ python3 -m pip download -d machine-stats-offline machine-stats
250-
$ tar czf machine-stats-offline.tar.gz machine-stats-offline
247+
```sh
248+
python3 -m pip download -d machine-stats-offline machine-stats
249+
tar czf machine-stats-offline.tar.gz machine-stats-offline
251250
```
252251

253252
2. Transfer the archive to the machine where you need to perform the offline
254253
installation (replace `<remote-host>` and `<remote-dir>` with the
255254
appropriate values):
256255

257-
```console
258-
$ scp machine-stats-offline.tar.gz <remote-host>:/<remote-dir>/
256+
```sh
257+
scp machine-stats-offline.tar.gz <remote-host>:/<remote-dir>/
259258
```
260259

261260
3. On the remote host, extract the archive and switch to extracted directory:
262261

263-
```
264-
$ tar xf machine-stats-offline.tar.gz
265-
$ cd machine-stats-offline
262+
```sh
263+
tar xf machine-stats-offline.tar.gz
264+
cd machine-stats-offline
266265
```
267266

268267
4. Install Machine Stats and its dependencies:
269268

270-
```
271-
$ python3 -m pip install --no-index --find-links . machine_stats-*.whl
269+
```sh
270+
python3 -m pip install --no-index --find-links . machine_stats-*.whl
272271
```
273272

274-
## Generating a `hosts` file from Tidal Migrations
273+
## Generating a `hosts` file from Tidal Accelerator
275274

276275
You can easily generate a hosts file directly from your server inventory in
277-
Tidal Migrations. For example you can use this command:
276+
Tidal Accelerator. For example you can use this command:
278277

279-
```
278+
```sh
280279
tidal export servers | jq '.[].host_name' > hosts
281280
```
282281

283282
This will create a file (`hosts`), in your current directory, that you can
284283
use above in Step 1.
285284

286-
Alternatively, if you use Tidal Migrations [Ansible Tower integration
285+
Alternatively, if you use Tidal Accelerator [Ansible Tower integration
287286
script](https://github.com/tidalmigrations/ansible-tower-integration) you can
288287
use its output to generate the `hosts` file for `machine_stats`.
289288

@@ -293,7 +292,7 @@ use its output to generate the `hosts` file for `machine_stats`.
293292

294293
### Usage
295294

296-
```
295+
```sh
297296
cd ansible-tower-integration
298297
./tidal_inventory.py | jq -r '.servers.hosts[]' > path/to/hosts
299298
```
@@ -304,16 +303,16 @@ cd ansible-tower-integration
304303

305304
If running Machine Stats as a CLI failed, try running it as the following:
306305

307-
```console
308-
$ python3 -m machine_stats
306+
```sh
307+
python3 -m machine_stats
309308
```
310309

311310
### How to permanently enable the Python 3.8 software collection on RHEL 7
312311

313312
You should always enable the Python software collection before using `pipenv`
314313
with the following command:
315314

316-
```
315+
```sh
317316
scl enable rh-python38 bash
318317
```
319318

@@ -323,7 +322,7 @@ is that the collection is already enabled at every login.
323322

324323
Using your preferred text editor, add the following line to your `~/.bashrc`:
325324

326-
```
325+
```sh
327326
# Add RHSCL Python 3 to my login environment
328327
source scl_source enable rh-python38
329328
```

0 commit comments

Comments
 (0)