Skip to content

Commit 3a4f8cd

Browse files
dulekEmilienM
authored andcommitted
Update README to match this being a package
1 parent 679f74c commit 3a4f8cd

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

tools/dsal/README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,25 +7,26 @@ management of configurations required to configure the boxes.
77

88
Utility producing useful configs that can be used to provision nodes.
99

10-
To use it you need to install deps:
10+
To use it you need to install it:
1111
```
12-
$ sudo pip install -r requirements.txt
12+
cd tools/dsal
13+
$ pip install .
1314
```
1415

15-
Also make sure to run it from its own directory.
16+
(You may need to add ~/.local/bin to PATH)
1617

1718
### Generating anaconda-ks.cfg
1819

1920
```
20-
./dsal_helper.py anaconda-cfg --disks sda,sdb --boot-disk sda <hostname>
21+
dsal-helper anaconda-cfg --disks sda,sdb --boot-disk sda <hostname>
2122
```
2223

2324
The file will get created as `anaconda/anaconda-ks-<hostname>`.
2425

2526
### Cloning and configuring dev-install
2627

2728
```
28-
./dsal_helper.py dev-install-cfg --fip-pool-start 10.1.10.51 --fip-pool-end 10.1.10.55 --ceph-disk /dev/sdb <hostname>
29+
dsal-helper dev-install-cfg --fip-pool-start 10.1.10.51 --fip-pool-end 10.1.10.55 --ceph-disk /dev/sdb <hostname>
2930
```
3031

3132
The dev-install will be cloned into `dev-install/<hostname>` and be ready to
@@ -35,7 +36,7 @@ VIP.
3536
### Generating install-config.yaml
3637

3738
```
38-
./dsal_helper.py openshift-install-cfg --pull-secret ../pull-secret.yaml --ssh-key ~/.ssh/id_rsa.pub <hostname>
39+
dsal-helper openshift-install-cfg --pull-secret ../pull-secret.yaml --ssh-key ~/.ssh/id_rsa.pub <hostname>
3940
```
4041

4142
Script will attempt to find free FIPs to use and create new ones if there are
@@ -52,7 +53,7 @@ There are few useful scripts in `scripts` folder.
5253

5354
### open-ssh.sh
5455

55-
This will lookup OpenShift master and workers SGs and add rules allowing SSH
56+
This will look up OpenShift master and workers SGs and add rules allowing SSH
5657
traffic to the VMs.
5758

5859
### fix-down-ports.sh
@@ -67,8 +68,6 @@ form of `4.x`, e.g. `get-latest.sh 4.9`. The binary will be placed in a
6768
directory named with the nightly version.
6869

6970
## TODOs
70-
* Correctly finding paths relative to the place where the script is.
71-
* Converting the script to an installable module with entrypoint?
7271
* Supporting anything else than 8.4 and 16.2.
7372
* Automating other useful activities:
7473
* Downloading openshift-install.

0 commit comments

Comments
 (0)