README
¶
Windows agent
The Windows Agent is the component that runs on the host Windows machine.
Usage
User commands
ubuntu-pro-agent
Ubuntu Pro for WSL agent
Ubuntu Pro for WSL agent for managing your pro-enabled distro.
ubuntu-pro-agent COMMAND [flags]
-c, --config string configuration file path
-h, --help help for ubuntu-pro-agent
-v, --verbosity count issue INFO (-v), DEBUG (-vv) or DEBUG with caller (-vvv) output
ubuntu-pro-agent clean
Removes all the agent's data and exits
ubuntu-pro-agent clean [flags]
-h, --help help for clean
-c, --config string configuration file path
-v, --verbosity count issue INFO (-v), DEBUG (-vv) or DEBUG with caller (-vvv) output
ubuntu-pro-agent completion
Generate the autocompletion script for the specified shell
Generate the autocompletion script for ubuntu-pro-agent for the specified shell. See each sub-command's help for details on how to use the generated script.
-h, --help help for completion
-c, --config string configuration file path
-v, --verbosity count issue INFO (-v), DEBUG (-vv) or DEBUG with caller (-vvv) output
ubuntu-pro-agent completion bash
Generate the autocompletion script for bash
Generate the autocompletion script for the bash shell.
This script depends on the 'bash-completion' package. If it is not installed already, you can install it via your OS's package manager.
To load completions in your current shell session:
source <(ubuntu-pro-agent completion bash)
To load completions for every new session, execute once:
ubuntu-pro-agent completion bash > /etc/bash_completion.d/ubuntu-pro-agent
ubuntu-pro-agent completion bash > $(brew --prefix)/etc/bash_completion.d/ubuntu-pro-agent
You will need to start a new shell for this setup to take effect.
ubuntu-pro-agent completion bash
-h, --help help for bash
--no-descriptions disable completion descriptions
-c, --config string configuration file path
-v, --verbosity count issue INFO (-v), DEBUG (-vv) or DEBUG with caller (-vvv) output
ubuntu-pro-agent completion fish
Generate the autocompletion script for fish
Generate the autocompletion script for the fish shell.
To load completions in your current shell session:
ubuntu-pro-agent completion fish | source
To load completions for every new session, execute once:
ubuntu-pro-agent completion fish > ~/.config/fish/completions/ubuntu-pro-agent.fish
You will need to start a new shell for this setup to take effect.
ubuntu-pro-agent completion fish [flags]
-h, --help help for fish
--no-descriptions disable completion descriptions
-c, --config string configuration file path
-v, --verbosity count issue INFO (-v), DEBUG (-vv) or DEBUG with caller (-vvv) output
ubuntu-pro-agent completion powershell
Generate the autocompletion script for powershell
Generate the autocompletion script for powershell.
To load completions in your current shell session:
ubuntu-pro-agent completion powershell | Out-String | Invoke-Expression
To load completions for every new session, add the output of the above command to your powershell profile.
ubuntu-pro-agent completion powershell [flags]
-h, --help help for powershell
--no-descriptions disable completion descriptions
-c, --config string configuration file path
-v, --verbosity count issue INFO (-v), DEBUG (-vv) or DEBUG with caller (-vvv) output
ubuntu-pro-agent completion zsh
Generate the autocompletion script for zsh
Generate the autocompletion script for the zsh shell.
If shell completion is not already enabled in your environment you will need to enable it. You can execute the following once:
echo "autoload -U compinit; compinit" >> ~/.zshrc
To load completions in your current shell session:
source <(ubuntu-pro-agent completion zsh)
To load completions for every new session, execute once:
ubuntu-pro-agent completion zsh > "${fpath[1]}/_ubuntu-pro-agent"
ubuntu-pro-agent completion zsh > $(brew --prefix)/share/zsh/site-functions/_ubuntu-pro-agent
You will need to start a new shell for this setup to take effect.
ubuntu-pro-agent completion zsh [flags]
-h, --help help for zsh
--no-descriptions disable completion descriptions
-c, --config string configuration file path
-v, --verbosity count issue INFO (-v), DEBUG (-vv) or DEBUG with caller (-vvv) output
ubuntu-pro-agent version
Returns version of agent and exits
ubuntu-pro-agent version [flags]
-h, --help help for version
-c, --config string configuration file path
-v, --verbosity count issue INFO (-v), DEBUG (-vv) or DEBUG with caller (-vvv) output
Hidden commands
Those commands are hidden from help and should primarily be used by the system or for debugging.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
ubuntu-pro-agent
Package main is the windows-agent entry point.
|
Package main is the windows-agent entry point. |
|
ubuntu-pro-agent/agent
Package agent represents the CLI UI for Ubuntu Pro agent.
|
Package agent represents the CLI UI for Ubuntu Pro agent. |
|
generate
|
|
|
doc
Package doc is a helper sub-module so that the documentation generation tools have access to the commands to document in this module.
|
Package doc is a helper sub-module so that the documentation generation tools have access to the commands to document in this module. |
|
internal
|
|
|
cloudinit
Package cloudinit has some helpers to set up cloud-init configuration.
|
Package cloudinit has some helpers to set up cloud-init configuration. |
|
config
Package config manages configuration parameters.
|
Package config manages configuration parameters. |
|
consts
Package consts defines the constants used by the project
|
Package consts defines the constants used by the project |
|
daemon
Package daemon is handling the TCP connection and connecting a GRPC service to it.
|
Package daemon is handling the TCP connection and connecting a GRPC service to it. |
|
daemon/daemontestutils
Package daemontestutils exports test helpers to be used in other packages that need to change internal behaviors of the daemon.
|
Package daemontestutils exports test helpers to be used in other packages that need to change internal behaviors of the daemon. |
|
distros/database
Package database contains the DistroDB object and its methods.
|
Package database contains the DistroDB object and its methods. |
|
distros/distro
Package distro abstracts a WSL distribution and deals manages all iteractions with it.
|
Package distro abstracts a WSL distribution and deals manages all iteractions with it. |
|
distros/distro/touchdistro
Package touchdistro exists to provide multiple, mockable implementations for the action of touching a distro, i.e.
|
Package touchdistro exists to provide multiple, mockable implementations for the action of touching a distro, i.e. |
|
distros/task
Package task exposes the Task interface and some utils related to it.
|
Package task exposes the Task interface and some utils related to it. |
|
distros/worker
Package worker manages the execution and queue of tasks.
|
Package worker manages the execution and queue of tasks. |
|
proservices
Package proservices is in charge of managing the GRPC services and all business-logic side.
|
Package proservices is in charge of managing the GRPC services and all business-logic side. |
|
proservices/landscape
Package landscape implements a client to the Landscape Host Agent API service.
|
Package landscape implements a client to the Landscape Host Agent API service. |
|
proservices/landscape/distroinstall
Package distroinstall exists to implement various utilities used by landscape that need to be mocked in tests.
|
Package distroinstall exists to implement various utilities used by landscape that need to be mocked in tests. |
|
proservices/registrywatcher
Package registrywatcher implements a service that updates the config every time the registry changes.
|
Package registrywatcher implements a service that updates the config every time the registry changes. |
|
proservices/registrywatcher/registry
Package registry simplifies read/write access to the registry and allows for mocking during tests.
|
Package registry simplifies read/write access to the registry and allows for mocking during tests. |
|
proservices/ui
Package ui implements the GRPC UI service.
|
Package ui implements the GRPC UI service. |
|
proservices/wslinstance
Package wslinstance implements the GRPC WSLInstance service.
|
Package wslinstance implements the GRPC WSLInstance service. |
|
tasks
Package tasks implements tasks to be submitted to distros.
|
Package tasks implements tasks to be submitted to distros. |
|
ubuntupro
Package ubuntupro provides functions to manage the Ubuntu Pro subscription.
|
Package ubuntupro provides functions to manage the Ubuntu Pro subscription. |
|
ubuntupro/contractclient
Package contractclient interfaces with the Contracts Server backend.
|
Package contractclient interfaces with the Contracts Server backend. |
|
ubuntupro/contracts
Package contracts manages Microsoft-Store-entitled subscriptions.
|
Package contracts manages Microsoft-Store-entitled subscriptions. |