From 811deee9e5b8cc42a3ea424ef873e9d69eb50cba Mon Sep 17 00:00:00 2001
From: elijah The command “leap” can be used to manage a bevy of servers running the LEAP platform from the comfort of your own home.
+
+
+
+
+
Manage trusted sysadmins (DEPRECATED)
-Adds a new trusted sysadmin by adding public keys to the “users” directory.
+Use leap user add
instead
Options
@@ -339,7 +396,7 @@ Add yourself as a trusted sysadmin by choosing among the public keys available fSee see what values are used in the generation of the certificates (like name and key size), run leap inspect provider
and look for the “ca” property. To see the details of the created certs, run leap inspect <file>
.
Creates a CSR for use in buying a commercial X.509 certificate.
@@ -383,6 +440,16 @@ Default Value: NoneCreates a Diffie-Hellman parameter file, needed for forward secret OpenVPN ciphers.
+Register an authorization key with the CA letsencrypt.org
+ +This only needs to be done once.
+ +Renews a certificate using the CA letsencrypt.org
+Creates or renews a X.509 certificate/key pair for a single node or all nodes, but only if needed.
@@ -447,12 +514,6 @@ Default Value: None -Output debug information.
- -The FILTER can be the name of a node, service, or tag.
-Apply recipes to a node or set of nodes.
@@ -548,6 +609,12 @@ Show last deploy only +Prints information regarding facts, history, and running processes for a node or nodes.
+ +The FILTER can be the name of a node, service, or tag.
+Prints details about a file. Alternately, the argument FILE can be the name of a node, service or tag.
@@ -585,16 +652,20 @@ Include disabled nodes in the list.Manage local virtual machines.
-This command provides a convient way to manage Vagrant-based virtual machines. If FILTER argument is missing, the command runs on all local virtual machines. The Vagrantfile is automatically generated in ‘test/Vagrantfile’. If you want to run vagrant commands manually, cd to ‘test’.
+This command provides a convenient way to manage Vagrant-based virtual machines. If FILTER argument is missing, the command runs on all local virtual machines. The Vagrantfile is automatically generated in ‘test/Vagrantfile’. If you want to run vagrant commands manually, cd to ‘test’.
-Destroys the virtual machine(s), reclaiming the disk space
+Print the status of local virtual machine(s)
Resets virtual machine(s) to the last saved snapshot
+Destroys the virtual machine(s), reclaiming the disk space
+Saves the current state of the virtual machine as a new snapshot
@@ -612,10 +683,6 @@ Default Value: LEAP/jessie -Print the status of local virtual machine(s)
-Shuts down the virtual machine(s)
@@ -674,13 +741,15 @@ Default Value: NoneTo set nested properties, property name can contain ‘.’, like so: leap node add web1 ssh.port:44
Separeate multiple values for a single property with a comma, like so: leap node add mynode services:webapp,dns
Separate multiple values for a single property with a comma, like so: leap node add mynode services:webapp,dns
Options
--local
-Make a local testing node (by automatically assigning the next available local IP address). Local nodes are run as virtual machines on your computer.--local
+Make a local testing node (by assigning the next available local IP address). Local nodes are run as virtual machines on your computer.
--vm
+Make a remote virtual machine for this node. Requires a valid cloud.json configuration.
--port PORT
Override the default SSH port.
+This command prepares a server to be used with the LEAP Platform by saving the server’s SSH host key, copying the authorized_keys file, installing packages that are required for deploying, and registering important facts. Node init must be run before deploying to a server, and the server must be running and available via the network. This command only needs to be run once, but there is no harm in running it multiple times.
Default Value: None
--echo
-If set, passwords are visible as you type them (default is hidden)
Removes all the files related to the node named NAME.
+Opens useful URLs in a web browser.
+ +NAME can be one or more of: monitor, web, docs, bug
+ +Options
+ +--env ENVIRONMENT
+Which environment to use (optional).
+Default Value: None
--[no-]ip
+To get around HSTS or DNS, open the URL using the IP address instead of the domain (optional).
Run a shell command remotely
+ +Runs the specified command COMMAND on each node in the FILTER set. For example, leap run 'uname -a' webapp
Options
+ +--port SSH_PORT
+Override default SSH port used when trying to connect to the server.
+Default Value: None
--[no-]stream
+If set, stream the output as it arrives. (default: –stream for a single node, –no-stream for multiple nodes)
Secure copy from FILE1 to FILE2. Files are specified as NODE_NAME:FILE_PATH. For local paths, omit “NODE_NAME:”.
@@ -778,6 +880,97 @@ Default Value: None +Manage trusted sysadmins
+ +Manage the trusted sysadmins that are configured in the ‘users’ directory.
+ +Adds a new trusted sysadmin
+ +Options
+ +--pgp-pub-key arg
+OpenPGP public key file for this new user
+Default Value: None
--ssh-pub-key arg
+SSH public key file for this new user
+Default Value: None
--self
+Add yourself as a trusted sysadmin by choosing among the public keys available for the current user.
Lists the configured sysadmins
+ +Removes a trusted sysadmin
+ +Manage remote virtual machines (VMs).
+ +This command provides a convenient way to manage virtual machines. FILTER may be a node filter or the ID of a virtual machine.
+ +Options
+ +--auth AUTH
+Choose which authentication credentials to use from the file cloud.json. If omitted, will default to the node’s vm.auth
property, or the first credentials in cloud.json
+Default Value: None
--[no-]mock
+Run as simulation, without actually connecting to a cloud provider. If set, –auth is ignored.
--[no-]wait
+Wait for servers to start/stop before continuing.
Allocates a new VM and/or associates it with node NAME.
+ +If node configuration file does not yet exist, it is created with the optional SEED values. You can run this command when the virtual machine already exists in order to update the node’s vm.id
property.
Binds a running VM instance to a node configuration.
+ +Afterwards, the VM will be assigned a label matching the node name, and the node config will be updated with the instance ID.
+ +Lists the registered SSH public keys for a particular VM provider.
+ +Registers a SSH public key for use when creating new VMs.
+ +Note that only people who are creating new VM instances need to have their key registered.
+ +Destroys one or more VMs
+ +Starts one or more VMs
+ +Print the status of all VMs
+ +Shuts down one or more VMs
+ +This keeps the storage allocated. To save resources, run leap vm rm
instead.