Arvados™ Docs
  1. Topics
    1. Arvados admin overview
  2. Users and Groups
    1. User management
    2. User management at the CLI
    3. Role group management at the CLI
    4. Reassign user data ownership
    5. Link user accounts
    6. Configuring federation
    7. Changing upstream login providers
    8. Synchronizing from external sources
    9. Securing API access with scoped tokens
    10. Automatic logout and token expiration
  3. Monitoring
    1. Logging
    2. Metrics
    3. Health checks
    4. Inspecting active requests
    5. Diagnostics
    6. Management token
    7. User activity report
    8. Memory and CPU profiling
  4. Data Management
    1. Configuring collection versioning
    2. Configuring collection's managed properties
    3. Restricting upload or download
    4. Balancing Keep servers
    5. Preventing container reuse
    6. Logs table management
    7. Metadata vocabulary
    8. Configuring storage classes
    9. Recovering data
    10. Measuring deduplication
    11. Faster garbage collection in S3
  5. Cloud
    1. Using Preemptible instances
    2. Testing cloud configuration
    3. Cloud dispatcher

Cloud dispatcher

The arvados-server program provides subcommands for accessing the cloud dispatcher’s management API interactively.

List instances

arvados-server instance list

Display a list of instances managed by the dispatcher.

A placeholder - in the instance column indicates that an instance has been requested but the cloud provider has not yet returned a response with an instance ID.

A placeholder - in the address column indicates that an instance has been requested but has not yet been assigned an IP address by the cloud provider.

A placeholder - in the last-container column indicates that the instance has not yet started a container.

Use the -header flag to display column names.

# arvados-server instance list -header
instance	address	state	idle-behavior	config-type	provider-type	price	last-container
i-03d59cfcfacf307ff	10.253.254.184	running	run	c5large	c5.large	0.085000	tordo-dz642-r6fz90awybvywr6
i-0df614e93e4170ae7	10.253.254.157	booting	run	t3small	t3.small	0.020800	-

Drain instances

# arvados-server instance drain <instance-id> [instance-id ...]

Set the indicated instances’ idle behavior to drain. Containers currently running will be allowed to continue, but when each instance becomes idle, it will be shut down.

Hold instances

# arvados-server instance hold <instance-id> [instance-id ...]

Set the indicated instances’ idle behavior to hold. The instances will not be shut down automatically. Containers currently running will be allowed to continue, but no new containers will be scheduled.

Run instances

# arvados-server instance run <instance-id> [instance-id ...]

Set the indicated instances’ idle behavior to run (the normal behavior). When the instances become idle, they will be eligible to run new containers. They will be shut down automatically when the configured idle threshold is reached.

Kill instances

# arvados-server instance kill [-reason "..."] <instance-id> [instance-id ...]

Shut down the indicated instances immediately, abandoning/failing any containers they are currently running.

The provided reason string will appear in the dispatcher’s log.

Previous: Testing cloud configuration

The content of this documentation is licensed under the Creative Commons Attribution-Share Alike 3.0 United States licence.
Code samples in this documentation are licensed under the Apache License, Version 2.0.