NAME
turtle - Hybris PSE multitool. Automates SSH connectivity to Hybris servers and other functions.
Written by Goh Maehashi and Tom Kendall.
USAGE
turtle [-b browser] [-c connect] [-i info] [-j jump] [-l list]
[-r refresh] [-w wiki] [-y hosts] [-push | -pull] <customer_code> <environment>
[-v vpn]
EXAMPLES
CONNECT MODE (c, -c, --connect)
turtle c vnx s app Connect to all app servers
turtle c vnx d web 1 Connect to web server 001.
turtle c vnx p srch 1-4 Connect to search servers 1-4.
turtle c vnx p appall Connect to all app and admin servers.
BROWSER MODE (b, -b, --browser)
turtle b vnx Requests environment from user then asks for URL.
turtle b vnx p Allows opening of HAC, HMC, STORE etc
turtle b vnx p hac Open the HAC page of the customer.
INFO MODE (i, -i, --info)
turtle i vnx Requests environment and displays overview of customer and environment.
turtle i vnx p Displays an overview of the customer and their environment.
SYNC MODE (push,-push,—push, pull,-pull,—pull)
turtle push smk p adm Push local files to remote adm Servers
turtle push smk p adm 1 Push local files to remote adm 001
turtle pull smh p adm Pull files from remote adm Servers to local
turtle pull smh p adm 1 Pull files from remote adm 001 to local
VPN MODE (v,vpn,-v,-vpn)
*(Password: sudo password, VPN RSA Password:Token key)
turtle vpn all start Start MA/FR VPN
turtle vpn all stop Stop MA/FR VPN
turtle vpn all status Check MA/FR VPN status
turtle vpn ma start Start MA VPN
turtle vpn fr stop Stop FR VPN
OTHER MODES
turtle l,--list Displays all local environment files and their project names.
turtle j,--jump fr Connect to a datacentre's jumpbox. Can also be used for ma.
turtle r,--refresh Refresh the environment directory.
turtle s,--settings Enables editing of Turtle's settings through vim.
turtle h,--help Displays this screen.
turtle y,--hosts Generates a hosts file based on the environment directory.
turtle w,--wiki Open pages related to the project's wiki pages.
}##Changelog (v9.1)
- Add VPN mode to start/stop both MA/FR VPN
(require openfortivpn installed https://github.com/adrienverge/openfortivpn) - Change VPN status check
- save and pass AD password during Push/Pull modes without multiple input
##Changelog (v9)
- Added Push/Pull modes to transfer files from remote to local or local to remote. Changes
- Change output display project name, data center and hybris version in turtle -l list mode.
- Add backoffice Page in browser mode
##Changelog (v8 beta final)
- Added environment selection for browser and info modes - modes can now be used without designating an environment in the command's parameters. Changes
- Fixed a bug preventing Turtle from detecting whether "turtle -r" was run properly, sometimes resulting in having to run this twice.
- Sort introduced for normal mode when connecting to servers with numbers greater than 10.
##Changelog (v8 beta 5)
- Connect mode is now default - you no longer need to specific -c or c to initiate connections.
- Dashes are no longer required before parameters. i.e. “turtle b jna s”
- Edit Turtle settings from within Turtle via “turtle -s”
- Turtle will refuse to connect to environments with incorrect env files as a form of error prevention.
- Fixed wiki mode not working for newly downloaded environments.
- Fixed hosts file generator not generating correct backoffice IPs for some environments.
- Added warning for incorrectly structured environment files.
- Label tweaks for when newWindowMode is false.
- 7 day env repository warning is suppressed when autoDailyRefresh is enabled.
- Added warning for List mode when there is a low number of environments.
- Added setting to choose the default editor for settings mode.
- Fixed and reimplemented errors for when no servers are found.
##Changelog (v8 beta 4)
- Added many new modes, including jumpbox, info, list, hosts, and wiki.
- Total syntax overhaul for better separation of functionality.
- Added colours for warnings and errors.
- Added warning if user is not on the right datacentre for browser URLs.
- Script settings separated into new file named CONFIG.
- Added warning if local repository is more than 7 days old.
- Heavily increased error handling, code comments and failsafes.
##FAQ
- How do I change the default terminal window size?
- Edit the CONFIG file in the turtle directory in order to change this.
- Why aren't all environment files included in a Turtle generated hosts file?
- Not all environments are live or have a specific purpose within hybris Cloud Services. These are therefore omitted from the generated hosts file. If an error is found with this process please report it to Tom Kendall.
##Future features and suggestions Load last test results from Wiki of a specific customer and environment. Generate a draw.io diagram based on a project's environment file. Allow for more settings based on user feedback. Low Priority: Check for new version of Turtle. Low Priority: Add support for other HEC datacentres. Low Priority: Add support for Windows. Low Priority: Build a GUI for Turtle.
##Support Turtle was written by Goh M,Tom Kendall and Ted T from the Sydney PSE team. Contact them for any issues or help.