How to install Landscape Client

Landscape Documentation
#1

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

Contents:

Install Landscape Client from the main repository

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

  1. Install the landscape-client package:

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

  2. 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.

  3. Configure:

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

Install Landscape Client from the 23.03 PPA

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

  1. Install the prerequisites:

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

  2. Add the PPA:

    sudo add-apt-repository -y ppa:landscape/self-hosted-23.03

  3. Install the landscape-client package:

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

  4. 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.

  5. 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:

  1. 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.

  2. 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"

  3. 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:

  1. Install landscape-client from a PPA:

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

  2. 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.

Landscape Documentation