Herpy dooves.
This commit is contained in:
16
README.md
16
README.md
@@ -89,7 +89,7 @@ For other systems you can check [here](https://pip.pypa.io/en/stable/installatio
|
||||
Assuming you have set up your accounts and have the dependencies installed, you can now start using SecDep.
|
||||
|
||||
Further instructions [here](assets/pages/usage/usage.md)
|
||||
# Sample outputs 📊
|
||||
# Some program outputs 📊
|
||||
|
||||
Images and videos of common tasks will reside [here](assets/pages/demo/demo.md)
|
||||
|
||||
@@ -103,6 +103,20 @@ The ip will be outputted after the creation of the virtual machine.
|
||||
|
||||
If for any reason you delete either the public or the provate key they will both be regenerated and you should probably delete the virtual machines that use it or find another way to log in and manually put the secdep.pub key to the authorized_keys file of the secdep user.
|
||||
|
||||
# Tips and tricks 🤩
|
||||
|
||||
For some tips and tricks to make your life easier check [this](assets/pages/tips_tricks/tips_n_tricks.md) out.
|
||||
|
||||
# Important disclaimers ⚠️
|
||||
|
||||
Carefully select the machine sizes
|
||||
|
||||
* Get a little familiar with the provider's pricing to not get caught by surprise 💸
|
||||
|
||||
According to the libcloud's documentation "unlimited" attributes like for example amazon's bandwidth get displayed as 0
|
||||
|
||||
* Don't blindly trust the scraped prices of the program output as they are not scraped by me but libcloud's library
|
||||
|
||||
# License 📜
|
||||
|
||||
[GPLv3](https://www.gnu.org/licenses/gpl-3.0.html)
|
||||
|
||||
BIN
assets/images/demo/instance-deletion.png
Normal file
BIN
assets/images/demo/instance-deletion.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 752 KiB |
BIN
assets/images/demo/instance-list-aws-gce.png
Normal file
BIN
assets/images/demo/instance-list-aws-gce.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 630 KiB |
BIN
assets/images/demo/instance-list-output.png
Normal file
BIN
assets/images/demo/instance-list-output.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 395 KiB |
@@ -1,7 +1,22 @@
|
||||
# Examples and output
|
||||
|
||||
## Instance listing
|
||||
## Instance listing 🪧
|
||||
|
||||
`python3 secdep.py -l`
|
||||
|
||||

|
||||
(sped up animation)
|
||||
|
||||

|
||||
|
||||
## Instance listing with 5 aws nodes
|
||||
|
||||

|
||||
|
||||
## Instance listing with aws and gce nodes
|
||||
|
||||

|
||||
|
||||
## Instance deletion 👋
|
||||
|
||||

|
||||
|
||||
|
||||
42
assets/pages/tips_tricks/tips_n_tricks.md
Normal file
42
assets/pages/tips_tricks/tips_n_tricks.md
Normal file
@@ -0,0 +1,42 @@
|
||||
## Put cloned repository to PATH 👣
|
||||
|
||||
By putting it in the path, you can use it from anywhere in the terminal.
|
||||
|
||||
For bash, you could run something like this:
|
||||
|
||||
`echo 'export PATH="$PATH:/path/to/SecDep"' >> ~/.bashrc`
|
||||
|
||||
For zsh, you could run something like this:
|
||||
|
||||
`echo 'export PATH="$PATH:/path/to/SecDep"' >> ~/.zshrc`
|
||||
|
||||
## Make it executable 🪄
|
||||
|
||||
`chmod +x /path/to/SecDep/secdep.py`
|
||||
|
||||
## Make an alias 🧙
|
||||
|
||||
For bash
|
||||
|
||||
`alias secdep='python3 /path/to/SecDep/secdep.py' >> ~/.bashrc`
|
||||
|
||||
For zsh
|
||||
|
||||
`alias secdep='python3 /path/to/SecDep/secdep.py' >> ~/.zshrc`
|
||||
|
||||
Or if it is in the path:
|
||||
|
||||
For bash
|
||||
|
||||
`alias secdep='secdep.py' >> ~/.bashrc`
|
||||
|
||||
For zsh
|
||||
|
||||
`alias secdep='secdep.py' >> ~/.zshrc`
|
||||
|
||||
## Usage after those steps 📖
|
||||
|
||||
We can now use the tool by running `secdep` in the terminal.
|
||||
|
||||
For example `secdep -h` will show the help menu.
|
||||
|
||||
|
Before Width: | Height: | Size: 1.0 MiB After Width: | Height: | Size: 1.0 MiB |
Reference in New Issue
Block a user