Copy page

unikraft instances

unikraft instances

Manage Unikraft Cloud instances.

Options inherited from parent commands

Code
  --config file               Path to the configuration file.
  --log-level level           Set the logging level. (default info)
  --log-type type             Set the log type. (default text)
  --profile name              Set the current profile.
  --telemetry                 Toggle usage analytics. (default true)
  --timeout duration          Set a deadline for the command (e.g. 30s, 5m, 1h).

Resource Fields

Field	Type	Operations
metro	string	create
name	string	create
uuid	string
tags	[string]	create/edit
annotations	{string: string}	create/edit
state	string	edit
image	imageref[github.com/distribution/reference.named]	create/edit
pull-policy		create
type	string	create
runtime
runtime.args	[string]	create/edit
runtime.env	{string: string}	create/edit
resources
resources.memory	integer	create/edit
resources.vcpus	integer	create/edit
resources.gpus	integer	create
service		create
service.name	string
service.uuid	string
service.services		create
service.domains		create
service.soft-limit		create
service.hard-limit		create
volumes		create/edit
roms		create/edit
plugins		create/edit
networks
gpus
timestamps
timestamps.created	relativetime
timestamps.started	relativetime
timestamps.stopped	relativetime
scale-to-zero		create/edit
scale-to-zero.enabled	bool
scale-to-zero.policy	string
scale-to-zero.stateful	bool
scale-to-zero.cooldown-time	integer
scale-to-zero.notify-time	integer
autokill		create/edit
autokill.time	integer
autokill.num-requests	integer
timing
timing.uptime	integer
timing.boot-time	integer
timing.net-time	integer
restart
restart.policy	string	create
restart.start-count	integer
restart.restart-count	integer
sched-priority	string	create/edit
autostart		create
replicas		create
features		create
vsock		create/edit
template		create
branch		create
checkpoint		create
stop
stop.reason	string
stop.origin	string
stop.errno	uintptr
stop.exit-code	integer
delete-lock	bool	edit

See Also

• unikraft: The Unikraft Command-Line Interface.
• unikraft instances get: Inspect a instance.
• unikraft instances wait: Wait for instances to match a filter.
• unikraft instances list: List instances.
• unikraft instances delete: Remove a instance.
• unikraft instances create: Create an instance.
• unikraft instances run: Create an instance and optionally follow its logs.
• unikraft instances edit: Edit an instance.
• unikraft instances template: Manage instance templates.
• unikraft instances checkpoint: Manage instance checkpoints.
• unikraft instances logs: Fetch and display instance logs.
• unikraft instances start: Start one or more instances.
• unikraft instances stop: Stop one or more instances.
• unikraft instances suspend: Suspend one or more instances.
• unikraft instances restart: Restart one or more instances.
• unikraft instances tunnel: Forward a local port to an unexposed instance.
• unikraft instances history: Show checkpoint history for an instance.
• unikraft instances shell: Open an interactive shell on a sandbox instance.
• unikraft instances exec: Execute a command on a sandbox instance.
• unikraft instances copy: Copy a file to or from a sandbox instance.
• unikraft instances write: Write a file to a sandbox instance.
• unikraft instances read: Read a file from a sandbox instance.