How to install Landscape Client

yanisa-hs · October 3, 2023, 8:38pm

There are multiple ways to install Landscape Client. This document describes each method.

Contents:

Main repository
PPA
Subordinate charm
Cloud-init
Snap

Install Landscape Client from Ubuntu’s `main` repository

Landscape Client is available in Ubuntu’s main repository in all Ubuntu releases, and is published independently of the self-hosted Landscape releases. This method is suitable when performing the installation through a terminal or shell scripting. To install Landscape Client from Ubuntu’s main repository:

Install the landscape-client package:

sudo apt update && sudo apt install -y landscape-client

Set environment variables:
```
LANDSCAPE_ACCOUNT_NAME='{ACCOUNT_NAME}'
LANDSCAPE_FQDN='{FQDN}'
LANDSCAPE_COMPUTER_TITLE='{COMPUTER_NAME}'
```
This code block includes the following values which must be changed:

{ACCOUNT_NAME}: Self-hosted Landscape users should set this to standalone. Landscape SaaS users should specify the account name in their Landscape account.

{FQDN}: Self-hosted Landscape users should set this to the FQDN used during their Landscape Server installation. Landscape SaaS users should set this to landscape.canonical.com.

{COMPUTER_NAME}: The name of the computer you’re installing Landscape Client on. You choose this name.

Configure:

sudo landscape-config --silent --account-name="${LANDSCAPE_ACCOUNT_NAME}" --computer-title="${LANDSCAPE_COMPUTER_TITLE}" --tags="" --script-users='nobody,landscape,root'

When you install Landscape Client from Ubuntu’s main repository, you install the version of Landscape Client that’s included in that version of Ubuntu. For the latest features, install Landscape Client from the PPA.

Install Landscape Client from a PPA

This method is suitable when performing the installation through a terminal or shell scripting. To install Landscape Client from a PPA:

Install the prerequisites:

sudo apt update && sudo apt install -y software-properties-common

Add the PPA, replacing {LANDSCAPE_PPA} with the appropriate repository:
```
sudo add-apt-repository -y {LANDSCAPE_PPA}
```
- {LANDSCAPE_PPA}: The PPA for the specific Landscape installation you’re using. The PPA for Landscape Beta is: ppa:landscape/self-hosted-beta. The PPA for the most recent stable Landscape LTS is: ppa:landscape/self-hosted-23.03.

Install the landscape-client package:

sudo apt update && sudo apt install -y landscape-client

Set environment variables:
```
LANDSCAPE_ACCOUNT_NAME='{ACCOUNT_NAME}'
LANDSCAPE_FQDN='{FQDN}'
LANDSCAPE_COMPUTER_TITLE='{COMPUTER_NAME}'
```
This code block includes the following values which must be changed:

{ACCOUNT_NAME}: Self-hosted Landscape users should set this to standalone. Landscape SaaS users should specify the account name in their Landscape account.

{FQDN}: Self-hosted Landscape users should set this to the FQDN used during their Landscape Server installation. Landscape SaaS users should set this to landscape.canonical.com.

{COMPUTER_NAME}: The name of the computer you’re installing Landscape Client on. You choose this name.

Configure:

sudo landscape-config --silent --account-name="${LANDSCAPE_ACCOUNT_NAME}" --computer-title="${LANDSCAPE_COMPUTER_TITLE}" --tags='' --script-users='nobody,landscape,root' --ping-url="http://${LANDSCAPE_FQDN}/ping" --url="https://${LANDSCAPE_FQDN}/message-system"

Install Landscape Client with the subordinate charm

This method is suitable when using charmed operators. To install Landscape Client with the subordinate charm:

Set environment variables:
```
LANDSCAPE_ACCOUNT_NAME='{ACCOUNT_NAME}'
LANDSCAPE_FQDN='{FQDN}'
```
This code block includes the following values which must be changed:

{ACCOUNT_NAME}: Self-hosted Landscape users should set this to standalone. Landscape SaaS users should specify the account name in their Landscape account.

{FQDN}: Self-hosted Landscape users should set this to the FQDN used during their Landscape Server installation. Landscape SaaS users should set this to landscape.canonical.com.

Deploy the charm:

juju deploy landscape-client --config account-name='standalone' --config tags='' --config script-users='nobody,landscape,root' --config ping-url="http://${LANDSCAPE_FQDN}/ping" --config url="https://${LANDSCAPE_FQDN}/message-system"

Relate the charm:

juju relate landscape-client <charm-name>

Install Landscape Client with Cloud-init

This method is suitable if it’s available during a machine’s provisioning stage. To install Landscape Client with cloud-init:

Install landscape-client from a PPA:

apt:
  sources:
    trunk-testing-ppa:
      source: ppa:landscape/self-hosted-23.03

Configure landscape-client. Landscape SaaS users should omit url and ping_url:
```
landscape:
  client:
    account_name: {ACCOUNT_NAME}
    computer_title: "{COMPUTER_NAME}"
    url: "https://{FQDN}/message-system"
    ping_url: "http://{FQDN}/ping"
```
This code block includes the following values which must be changed:

{ACCOUNT_NAME}: Self-hosted Landscape users should set this to standalone. Landscape SaaS users should specify the account name in their Landscape account.

{COMPUTER_NAME}: The name of the computer you’re installing Landscape Client on. You choose this name.

{FQDN}: Self-hosted Landscape users should set this to the FQDN used during their Landscape Server installation. Landscape SaaS users should omit url and ping_url.

For additional information, see the cloud-init Landscape module documentation.

Install the `landscape-client` snap

The Landscape Client snap doesn’t support management of Debian packages.

You must be running a self-hosted Landscape server version 23.10 or later (or beta) to use the snap.

You can install the Landscape Client snap from the Snap Store. For more detailed instructions and information on the snap’s limitations, see how to install the Landscape Client snap.

The snap is suitable for Ubuntu Core devices but can also be used on classic Ubuntu systems. For more information on installation, configuration and usage of the snap, see our collection of how-to guides for the Landscape Client snap.