konsthol/SecDep
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Apparently works-for-me is a crappy excuse.

Browse Source
This commit is contained in:
konsthol
2023-03-23 01:41:16 +02:00
parent ab7c365b50
commit 2e71478e1c
5 changed files with 33 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
assets/pages/usage/usage.md
View File

@@ -1,12 +1,16 @@
# First run
# First run 🏃
What will happen on your system on first run? well, SecDep will create a `.env` file in the root directory of the project. This file is needed to store the authentication values needed to access the cloud providers. You will be asked for every needed value for every supported provider and if you don't need one you should just press enter to leave it's respecting values empty.
### Configuration ⚙️
Should you ever change your mind you can always edit the `.env` file manually or run `python3 secdep.py -v` or `python3 secdep.py --values` to change the values you want.
### Key Creation 🔐
Then a public and a private ssh key will be generated and stored in the root of the directory. The public key will be added to the `~/.ssh/authorized_keys` file of a secdep user that will be created on the virtual machines. The private key will be used to connect to the virtual machines.
# Creating a virtual machine
# Creating a virtual machine 🖥️
To create a virtual machine you can run `python3 secdep.py -P <provider> -c` or `python3 secdep.py --provider <provider> --create` where `<provider>` is either `gce`, `azure` or `aws`.
@@ -19,7 +23,7 @@ You will be asked to enter some information regarding the virtual machine you wa
and then you will be shown the chosen values and asked to confirm the creation of the virtual machine.
# Skipping the confirmation and some options
# Skipping the confirmation and some options 🙅
If you want to skip the confirmation or some of the asked values you can specify them using command line flags as so
@@ -51,7 +55,7 @@ or with specific values
`python3 secdep.py -P aws -c -n test-node -s t3.micro -i ami-0246e87085c5c98e3 -y`
# Finding valid values
# Finding valid values for the flags 🕵️
If you want to find valid values for the image you can run `python3 secdep.py -P <provider> -I -p` or `python3 secdep.py --provider <provider> --listimages --print` where `<provider>` is either `gce`, `azure` or `aws`.
@@ -155,6 +159,6 @@ If you want to delete them all in either case you can use the deleteall action i
Same goes for stop, start and reboot.
# SSHing into a virtual machine
# SSHing into a virtual machine 🚀
To SSH into a virtual machine you get the choice from `python3 secdep.py -ssh` or `python3 secdep.py -P gce -ssh` to only choose from the gce instances.