mirror of
https://git.isptech.ru/ISPsystem/isp-maintenance.git
synced 2025-02-01 10:50:52 +01:00
Compare commits
No commits in common. "99dd12226277337ab8e10c09f864375cabc0b46b" and "5815c84b07bb696834e583b2cf70a95ccd196116" have entirely different histories.
99dd122262
...
5815c84b07
172
README.md
172
README.md
@ -6,175 +6,3 @@ Maintenance application for quick access, check and resolve issues VM/DCImanager
|
|||||||
|
|
||||||
|
|
||||||
### See [CONTRIBUTING.md](CONTRIBUTING.md) for a general overview of how to contribute
|
### See [CONTRIBUTING.md](CONTRIBUTING.md) for a general overview of how to contribute
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## How to use gogo companion:
|
|
||||||
|
|
||||||
|
|
||||||
#### Dependencies
|
|
||||||
|
|
||||||
ОС: Linux, Mac, Windows
|
|
||||||
Shell: bash
|
|
||||||
|
|
||||||
|
|
||||||
#### Installation
|
|
||||||
|
|
||||||
- download or copy the script from the root of the repository `/scripts/gogo/gogo.sh`
|
|
||||||
- to call the script without specifying the full path, put it in the directory that is in $PATH (in the future, I assume that you will have it `~/.local/bin/`)
|
|
||||||
|
|
||||||
```console
|
|
||||||
curl https://git.isptech.ru/ISPsystem/isp-maintenance/raw/branch/main/scripts/gogo/gogo.sh -o ~/.local/bin/gogo && chmod u+x ~/.local/bin/gogo
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Configuration
|
|
||||||
|
|
||||||
For the script to work, you need a configuration file with settings `~/.config/gogo/gogo.conf`
|
|
||||||
|
|
||||||
This config contains the following fields that are read every time you start
|
|
||||||
|
|
||||||
```
|
|
||||||
GO_SERVER_ADDR_RUSSIAN=
|
|
||||||
GO_SERVER_ADDR_GERMANY=
|
|
||||||
GO_SERVER_ADDR_TEST=
|
|
||||||
VAULT_SERVER_ADDR=
|
|
||||||
SSH_PRIVATE_KEY_USER=
|
|
||||||
SSH_PRIVATE_KEY_PATH=
|
|
||||||
SSH_PUBLIC_KEY_PATH=
|
|
||||||
SSH_CRT_FILE=
|
|
||||||
MGRCTL_IMAGE=mois3y/mgrctl:latest
|
|
||||||
DEBUG_MODE=false
|
|
||||||
```
|
|
||||||
|
|
||||||
Please fill in the fields with current data, write the path to the keys and certificate in full `/home/username/.ssh/id_ecdsa` and so on.
|
|
||||||
For security reasons, server addresses and paths to keys are not indicated here.
|
|
||||||
|
|
||||||
For your convenience, the config can be filled out interactively
|
|
||||||
|
|
||||||
```console
|
|
||||||
gogo --init
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
#### Usage
|
|
||||||
|
|
||||||
- Get a temporary ssh certificate
|
|
||||||
|
|
||||||
```console
|
|
||||||
gogo --crt
|
|
||||||
```
|
|
||||||
|
|
||||||
- Check your connection to test servers in both locations
|
|
||||||
|
|
||||||
```console
|
|
||||||
gogo --test
|
|
||||||
```
|
|
||||||
|
|
||||||
- If the connection is successful, you can use the script. You are beautiful!
|
|
||||||
|
|
||||||
|
|
||||||
#### Examples
|
|
||||||
|
|
||||||
- Connect to BILLmanager 6 via ssh port 22 and interface port 443
|
|
||||||
|
|
||||||
```console
|
|
||||||
gogo --bill my.example.com
|
|
||||||
```
|
|
||||||
or
|
|
||||||
```console
|
|
||||||
gogo --bill my.example.com -p 22 -wp 443
|
|
||||||
```
|
|
||||||
|
|
||||||
- Connect to BILLmanager 6 again without generating an access key to the interface
|
|
||||||
|
|
||||||
```console
|
|
||||||
gogo --bill my.example.com --ssh
|
|
||||||
```
|
|
||||||
|
|
||||||
- Connect to DNSmanager 6 via ssh port 22 and interface port 1501
|
|
||||||
|
|
||||||
```console
|
|
||||||
gogo --dns my.example.com -p 22 -wp 1501
|
|
||||||
```
|
|
||||||
|
|
||||||
- Connect to DCImanager 6 via ssh port 2222 and interface 443 port
|
|
||||||
|
|
||||||
```console
|
|
||||||
gogo --dci vm.example.com -p 2222
|
|
||||||
```
|
|
||||||
|
|
||||||
- Connect to VMmanager 6 via ssh port 2222 and interface port 443
|
|
||||||
|
|
||||||
```console
|
|
||||||
gogo --vm 228.228.228.228 -p 2222
|
|
||||||
```
|
|
||||||
|
|
||||||
- Connect to VMmanager 6 via ssh port 22 and interface port 443, indicating the id of a specific user and generate 3 keys
|
|
||||||
|
|
||||||
```console
|
|
||||||
gogo --vm vm.example.com --mgrctl auth user access --id 1488 --count 1
|
|
||||||
```
|
|
||||||
|
|
||||||
- The same thing, just print the command that is executed on the server side into the console, you can run it later simply by copying it
|
|
||||||
|
|
||||||
```console
|
|
||||||
gogo --vm vm.example.com --tty --mgrctl auth user access --id 1488 --count 1
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
Connect to VMmanager 6 via ssh port 22 and interface port 443 via DE go3 server
|
|
||||||
|
|
||||||
```console
|
|
||||||
gogo --vm vm.example.com -p 22 --de
|
|
||||||
```
|
|
||||||
|
|
||||||
Connect to DCImanager 6 via ssh port 22 and interface port 443 via the old go method
|
|
||||||
|
|
||||||
```console
|
|
||||||
gogo --dci dci.example.com -p 22 --go
|
|
||||||
```
|
|
||||||
|
|
||||||
##### There are also examples in `help`
|
|
||||||
|
|
||||||
```console
|
|
||||||
gogo --help
|
|
||||||
|
|
||||||
Usage: gogo [options [parameters]]
|
|
||||||
|
|
||||||
Examples:
|
|
||||||
|
|
||||||
gogo --init | init config file
|
|
||||||
gogo --crt | get ssh certificate for go3 connections
|
|
||||||
gogo --test | check go3 connection availability
|
|
||||||
|
|
||||||
gogo --bill my.example.com
|
|
||||||
gogo --vm my.example.com --de | connect throw DE go3 server
|
|
||||||
gogo --vm 0.0.0.0 --ssh | only ssh access
|
|
||||||
gogo --vm 0.0.0.0 --tty | use mgrctl interactive
|
|
||||||
|
|
||||||
gogo --dci 0.0.0.0 --mgrctl auth user access --id 3 --count 5
|
|
||||||
gogo --dci 0.0.0.0 --mgrctl auth user ls --admins
|
|
||||||
gogo --vm 0.0.0.0 --port 22122 --mgrctl auth user ls --admins
|
|
||||||
gogo --vm 0.0.0.0 --tty --mgrctl auth user ls --admins
|
|
||||||
gogo --dns ns1.example.com --web-port 1501
|
|
||||||
gogo --dns ns1.example.com --port 22122 --web-port 1501
|
|
||||||
gogo --bill my.example.com --port 22 --web-port 1501
|
|
||||||
|
|
||||||
Options:
|
|
||||||
|
|
||||||
--vm[dci|bill|dns|ip] expected ip_addr required
|
|
||||||
--port | -p ssh port, default 22
|
|
||||||
--web-port | -wp web port, default 443
|
|
||||||
--go/--go3 go version, default go3
|
|
||||||
--de connect throw DE go3 server
|
|
||||||
--ssh open only ssh session
|
|
||||||
--tty for vm6/dci6 echo cmd for run container
|
|
||||||
--mgrctl [args] for vm6/dci6 customize access params
|
|
||||||
|
|
||||||
Single options:
|
|
||||||
--init | -i generate configuration
|
|
||||||
--crt | -c generate ssh cert
|
|
||||||
--test | -t check go3 connection availability
|
|
||||||
--version | -v print version
|
|
||||||
--help | -h print this message and exit
|
|
||||||
```
|
|
@ -5,7 +5,7 @@
|
|||||||
# -- -- -- -- -- --
|
# -- -- -- -- -- --
|
||||||
|
|
||||||
# INIT GLOBAL VARIABLES:
|
# INIT GLOBAL VARIABLES:
|
||||||
_VERSION="0.1.1"
|
_VERSION="0.1.0"
|
||||||
_SCRIPT_NAME="$(basename $0)"
|
_SCRIPT_NAME="$(basename $0)"
|
||||||
_GO_CMD="go3"
|
_GO_CMD="go3"
|
||||||
_DEBUG_MODE=false
|
_DEBUG_MODE=false
|
||||||
@ -67,10 +67,8 @@ help() {
|
|||||||
printf " \n"
|
printf " \n"
|
||||||
printf "${script} --init | init config file \n"
|
printf "${script} --init | init config file \n"
|
||||||
printf "${script} --crt | get ssh certificate for go3 connections \n"
|
printf "${script} --crt | get ssh certificate for go3 connections \n"
|
||||||
printf "${script} --test | check go3 connection availability \n"
|
|
||||||
printf " \n"
|
printf " \n"
|
||||||
printf "${script} --bill my.example.com \n"
|
printf "${script} --bill my.example.com \n"
|
||||||
printf "${script} --vm my.example.com --de | connect throw DE go3 server \n"
|
|
||||||
printf "${script} --vm 0.0.0.0 --ssh | only ssh access \n"
|
printf "${script} --vm 0.0.0.0 --ssh | only ssh access \n"
|
||||||
printf "${script} --vm 0.0.0.0 --tty | use mgrctl interactive \n"
|
printf "${script} --vm 0.0.0.0 --tty | use mgrctl interactive \n"
|
||||||
printf " \n"
|
printf " \n"
|
||||||
@ -88,15 +86,12 @@ help() {
|
|||||||
printf " --port | -p ssh port, default 22 \n"
|
printf " --port | -p ssh port, default 22 \n"
|
||||||
printf " --web-port | -wp web port, default 443 \n"
|
printf " --web-port | -wp web port, default 443 \n"
|
||||||
printf " --go/--go3 go version, default go3 \n"
|
printf " --go/--go3 go version, default go3 \n"
|
||||||
printf " --de connect throw DE go3 server \n"
|
|
||||||
printf " --ssh open only ssh session \n"
|
printf " --ssh open only ssh session \n"
|
||||||
printf " --tty for vm6/dci6 echo cmd for run container \n"
|
printf " --tty for vm6/dci6 echo cmd for run container \n"
|
||||||
printf " --mgrctl [args] for vm6/dci6 customize access params \n"
|
printf " --mgrctl [args] for vm6/dci6 customize access params \n"
|
||||||
printf " \n"
|
printf " \n"
|
||||||
printf "Single options: \n"
|
|
||||||
printf " --init | -i generate configuration \n"
|
printf " --init | -i generate configuration \n"
|
||||||
printf " --crt | -c generate ssh cert \n"
|
printf " --crt | -c generate ssh cert \n"
|
||||||
printf " --test | -t check go3 connection availability \n"
|
|
||||||
printf " --version | -v print version \n"
|
printf " --version | -v print version \n"
|
||||||
printf " --help | -h print this message and exit \n"
|
printf " --help | -h print this message and exit \n"
|
||||||
}
|
}
|
||||||
@ -120,9 +115,7 @@ init_config() {
|
|||||||
continue_handler
|
continue_handler
|
||||||
fi
|
fi
|
||||||
# get user unputs:
|
# get user unputs:
|
||||||
read -p "Enter russian go server address: " _GO_SERVER_ADDR_RUSSIAN
|
read -p "Enter go server address: " _GO_SERVER_ADDR
|
||||||
read -p "Enter germany go server address: " _GO_SERVER_ADDR_GERMANY
|
|
||||||
read -p "Enter test go server address: " _GO_SERVER_ADDR_TEST
|
|
||||||
read -p "Enter vault server address: " _VAULT_SERVER_ADDR
|
read -p "Enter vault server address: " _VAULT_SERVER_ADDR
|
||||||
read -p "Enter username: " _SSH_PRIVATE_KEY_USER
|
read -p "Enter username: " _SSH_PRIVATE_KEY_USER
|
||||||
read -p "Enter full path to ssh private key: " _SSH_PRIVATE_KEY_PATH
|
read -p "Enter full path to ssh private key: " _SSH_PRIVATE_KEY_PATH
|
||||||
@ -132,9 +125,7 @@ init_config() {
|
|||||||
# save config:
|
# save config:
|
||||||
mkdir -p $_CONFIG_DIR
|
mkdir -p $_CONFIG_DIR
|
||||||
cat << EOF > "${_CONFIG}"
|
cat << EOF > "${_CONFIG}"
|
||||||
GO_SERVER_ADDR_RUSSIAN=$_GO_SERVER_ADDR_RUSSIAN
|
GO_SERVER_ADDR=$_GO_SERVER_ADDR
|
||||||
GO_SERVER_ADDR_GERMANY=$_GO_SERVER_ADDR_GERMANY
|
|
||||||
GO_SERVER_ADDR_TEST=$_GO_SERVER_ADDR_TEST
|
|
||||||
VAULT_SERVER_ADDR=$_VAULT_SERVER_ADDR
|
VAULT_SERVER_ADDR=$_VAULT_SERVER_ADDR
|
||||||
SSH_PRIVATE_KEY_USER=$_SSH_PRIVATE_KEY_USER
|
SSH_PRIVATE_KEY_USER=$_SSH_PRIVATE_KEY_USER
|
||||||
SSH_PRIVATE_KEY_PATH=$_SSH_PRIVATE_KEY_PATH
|
SSH_PRIVATE_KEY_PATH=$_SSH_PRIVATE_KEY_PATH
|
||||||
@ -165,16 +156,9 @@ load_config() {
|
|||||||
|
|
||||||
while IFS="=" read -r key value; do
|
while IFS="=" read -r key value; do
|
||||||
case "$key" in
|
case "$key" in
|
||||||
"GO_SERVER_ADDR_RUSSIAN")
|
"GO_SERVER_ADDR")
|
||||||
_GO_SERVER_ADDR_RUSSIAN="$value"
|
|
||||||
_GO_SERVER_ADDR="$value"
|
_GO_SERVER_ADDR="$value"
|
||||||
;;
|
;;
|
||||||
"GO_SERVER_ADDR_GERMANY")
|
|
||||||
_GO_SERVER_ADDR_GERMANY="$value"
|
|
||||||
;;
|
|
||||||
"GO_SERVER_ADDR_TEST")
|
|
||||||
_GO_SERVER_ADDR_TEST="$value"
|
|
||||||
;;
|
|
||||||
"VAULT_SERVER_ADDR")
|
"VAULT_SERVER_ADDR")
|
||||||
_VAULT_SERVER_ADDR="$value"
|
_VAULT_SERVER_ADDR="$value"
|
||||||
;;
|
;;
|
||||||
@ -396,24 +380,6 @@ renewal_crt() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
test_go3_connection() {
|
|
||||||
# force only ssh connections without platform features:
|
|
||||||
_IS_SSH_ONLY=true
|
|
||||||
# set fake client address:
|
|
||||||
_PLATFORM_IP_ADDR="${_GO_SERVER_ADDR_TEST}"
|
|
||||||
_PLATFORM_SSH_PORT=22
|
|
||||||
|
|
||||||
echo "Run TEST: $_GO_SERVER_ADDR_RUSSIAN connection"
|
|
||||||
get_access
|
|
||||||
|
|
||||||
echo "-- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --"
|
|
||||||
|
|
||||||
echo "Run TEST: $_GO_SERVER_ADDR_GERMANY connection"
|
|
||||||
_GO_SERVER_ADDR="${_GO_SERVER_ADDR_GERMANY}"
|
|
||||||
get_access
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
# Parse user options
|
# Parse user options
|
||||||
optparser() {
|
optparser() {
|
||||||
# count user-passed options:
|
# count user-passed options:
|
||||||
@ -454,9 +420,6 @@ optparser() {
|
|||||||
--go|--go3)
|
--go|--go3)
|
||||||
_GO_CMD=$(sed 's~[^[:alnum:]/]\+~~g' <<< "$1")
|
_GO_CMD=$(sed 's~[^[:alnum:]/]\+~~g' <<< "$1")
|
||||||
;;
|
;;
|
||||||
--de)
|
|
||||||
_GO_SERVER_ADDR="${_GO_SERVER_ADDR_GERMANY}"
|
|
||||||
;;
|
|
||||||
--mgrctl|--tty|--ssh)
|
--mgrctl|--tty|--ssh)
|
||||||
if [[ "$1" == "--mgrctl" ]]; then
|
if [[ "$1" == "--mgrctl" ]]; then
|
||||||
_IS_MGRCTL_ARGS=true
|
_IS_MGRCTL_ARGS=true
|
||||||
@ -477,10 +440,6 @@ optparser() {
|
|||||||
renewal_crt
|
renewal_crt
|
||||||
exit 0
|
exit 0
|
||||||
;;
|
;;
|
||||||
--test|-t)
|
|
||||||
test_go3_connection
|
|
||||||
exit 0
|
|
||||||
;;
|
|
||||||
--help|-h)
|
--help|-h)
|
||||||
help
|
help
|
||||||
exit 0
|
exit 0
|
||||||
|
Loading…
Reference in New Issue
Block a user