ESGF Command Line Interface¶
This program must be run as root or a root equivalent shell: (sudo -s)
usage: esg_node.py [-h] [--install] [--base] [--update] [--upgrade]
[--install-local-certs] [--generate-esgf-csrs]
[--generate-esgf-csrs-ext] [--cert-howto] [--fix-perms]
[--type {data,index,idp,compute,all} [{data,index,idp,compute,all} ...]]
[--set-type SETTYPE [SETTYPE ...]] [--get-type] [--start]
[--stop] [--restart] [--status] [--update-apache-conf] [-v]
[--recommended_setup] [--custom_setup] [--use-local-files]
[--use-local-mirror] [--devel] [--prod] [--debug]
[--clear-envfile] [--clear-my-certs] [--info] [--config-db]
[--backup-db] [--restore-db] [--verify-thredds-credentials]
[--uninstall] [--get-idp-peer] [--set-idp-peer]
[--get-default-peer] [--set-default-peer]
[--get-peer-group] [--set-peer-group]
[--no-auto-fetch-certs] [--set-auto-fetch-certs]
[--fetch-esgf-certs] [--rebuild-truststore]
[--add-my-cert-to-truststore] [--generate-ssl-key-and-csr]
[--migrate-tomcat-credentials-to-esgf] [--update-temp-ca]
[--check-certs]
[--install-ssl-keypair INSTALLSSLKEYPAIR [INSTALLSSLKEYPAIR ...]]
[--optimize-index] [--myproxy-sanity-check] [--noglobus]
[--force-install] [--index-config] [--check-shards]
[--add-replica-shard ADDREPLICASHARD ADDREPLICASHARD]
[--remove-replica-shard REMOVEREPLICASHARD REMOVEREPLICASHARD]
[--update-publisher-resources]
Named Arguments¶
| --install |
Default: False |
| --base | Install on base third party components Default: False |
| --update | Updates the node manager Default: False |
| --upgrade | Upgrade the node manager Default: False |
| --install-local-certs | |
Install local certificates Default: False | |
| --generate-esgf-csrs | |
Generate CSRs for a simpleCA CA certificate and/or web container certificate Default: False | |
| --generate-esgf-csrs-ext | |
Generate CSRs for a node other than the one you are running Default: False | |
| --cert-howto | Provides information about certificate management Default: False |
| --fix-perms, --fixperms | |
Fix permissions Default: False | |
| --type, -t, --flavor | |
Possible choices: data, index, idp, compute, all Set type | |
| --set-type | Sets the type value to be used at next start up |
| --get-type, --show-type | |
Returns the last stored type code value of the last run node configuration (data=4 +| index=8 +| idp=16) Default: False | |
| --start | Start the node’s services Default: False |
| --stop, --shutdown | |
Stops the node’s services Default: False | |
| --restart | Restarts the node’s services (calls stop then start :-/) Default: False |
| --status | Status on node’s services Default: False |
| --update-apache-conf | |
Update Apache configuration Default: False | |
| -v, --version | Displays the version of this script Default: False |
| --recommended_setup | |
Sets esgsetup to use the recommended, minimal setup Default: False | |
| --custom_setup | Sets esgsetup to use a custom, user-defined setup Default: False |
| --use-local-files | |
Sets a flag for using local files instead of attempting to fetch a remote file Default: False | |
| --use-local-mirror | |
Sets the installer to fetch files from a mirror directory that is on the same server in which the installation is being run Default: False | |
| --devel | Sets the installation type to the devel build Default: False |
| --prod | Sets the installation type to the production build Default: False |
| --debug | Sets the logging level to debug Default: False |
| --clear-envfile | |
Delete (and backup) existing envfile (/etc/esg.env) Default: False | |
| --clear-my-certs | |
Delete certficates from $HOME/.globus/certificates Default: False | |
| --info | Print basic info about ESGF installation Default: False |
| --config-db | configures the database i.e. sets up table schema based on the the node type. Default: False |
| --backup-db | Backs up the Postgres database Default: False |
| --restore-db | Restores the Postgres database from a previous backup Default: False |
| --verify-thredds-credentials | |
Verifies Thredds credentials Default: False | |
| --uninstall, --purge | |
Uninstalls the ESGF installation Default: False | |
| --get-idp-peer | Displays the IDP peer node name Default: False |
| --set-idp-peer, --set-admin-peer | |
Selects the IDP peer node Default: False | |
| --get-default-peer | |
Displays the default peer Default: False | |
| --set-default-peer | |
Sets the default peer Default: False | |
| --get-peer-group, --get-peer-groups | |
Displays the peer groups Default: False | |
| --set-peer-group, --set-peer-groups | |
Sets the peer groups Default: False | |
| --no-auto-fetch-certs | |
| Default: False | |
| --set-auto-fetch-certs | |
| Default: False | |
| --fetch-esgf-certs | |
| Default: False | |
| --rebuild-truststore | |
| Default: False | |
| --add-my-cert-to-truststore | |
| Default: False | |
| --generate-ssl-key-and-csr | |
| Default: False | |
| --migrate-tomcat-credentials-to-esgf | |
| Default: False | |
| --update-temp-ca | |
| Default: False | |
| --check-certs | Default: False |
| --install-ssl-keypair, --install-keypair | |
| --optimize-index | |
| Default: False | |
| --myproxy-sanity-check | |
| Default: False | |
| --noglobus | Default: False |
| --force-install | |
| Default: False | |
| --index-config | Default: False |
| --check-shards | Default: False |
| --add-replica-shard | |
| Specify a hostname and port of the replica shard to add | |
| --remove-replica-shard | |
| Specify a hostname and port of the replica shard to remove | |
| --update-publisher-resources | |
| Default: False | |
NOTE:
You must be root or effectively root to run this program, prefixing the command with sudo will not allow the use of needed environment variables!!!! If you must use sudo, do so only to become root proper then source your user’s .[bash]rc file so that root has it’s environment set accordingly! Or you can more simply become root using sudo’s “-s” flag. After a full install there will be a file created (/etc/esg.env) that has the basic environment vars that were used and set during the installation - this should be sourced by users of this application stack.