From 2899c168107d61fe4ac6bbc001771db63d77d3d6 Mon Sep 17 00:00:00 2001 From: Sally Makin Date: Fri, 18 Oct 2024 11:36:17 +0100 Subject: [PATCH] Delete unnecessary pages --- dev-docs/references/architecture.md | 18 ------------- dev-docs/references/daily_builds.md | 4 --- dev-docs/references/directory_layout.md | 31 ----------------------- dev-docs/references/enabling_a_service.md | 21 --------------- dev-docs/references/terminology.md | 13 ---------- 5 files changed, 87 deletions(-) delete mode 100644 dev-docs/references/architecture.md delete mode 100644 dev-docs/references/daily_builds.md delete mode 100644 dev-docs/references/directory_layout.md delete mode 100644 dev-docs/references/enabling_a_service.md delete mode 100644 dev-docs/references/terminology.md diff --git a/dev-docs/references/architecture.md b/dev-docs/references/architecture.md deleted file mode 100644 index bcd412b744..0000000000 --- a/dev-docs/references/architecture.md +++ /dev/null @@ -1,18 +0,0 @@ -# Architecture - -Ubuntu Pro Client is a python3-based command line -utility. It provides a CLI to attach, detach, enable, -disable and check status of support related services. - -The package `ubuntu-pro-client` also provides a C++ APT hook which helps -advertise ESM service and available packages in MOTD and during various apt -commands. - -The `ubuntu-pro-auto-attach` package delivers auto-attach functionality via a -systemd service for various cloud platforms. - -By default, Ubuntu machines are deployed in an unattached state. A machine can -get manually or automatically attached to a specific contract by interacting -with the Contract Server REST API. Any change in state of services or machine -attach results in additional interactions with the Contract Server API to -validate such operations. diff --git a/dev-docs/references/daily_builds.md b/dev-docs/references/daily_builds.md deleted file mode 100644 index ea52c39d46..0000000000 --- a/dev-docs/references/daily_builds.md +++ /dev/null @@ -1,4 +0,0 @@ -# Daily Builds - -On Launchpad, there is a [daily build recipe](https://code.launchpad.net/~canonical-server/+recipe/ua-client-daily), -which will build the client and place it in the [ua-client-daily PPA](https://code.launchpad.net/~ua-client/+archive/ubuntu/daily). diff --git a/dev-docs/references/directory_layout.md b/dev-docs/references/directory_layout.md deleted file mode 100644 index 1fc1f77192..0000000000 --- a/dev-docs/references/directory_layout.md +++ /dev/null @@ -1,31 +0,0 @@ -# Directory layout - -The following describes the intent of Ubuntu Pro Client related directories: - -| File/Directory | Intent | -| -------- | -------- | -| ./tools | Helpful scripts used to publish, release or test various aspects of Ubuntu Pro Client | -| ./features/ | Behave BDD integration tests for Ubuntu Pro Client -| ./uaclient/ | collection of python modules which will be packaged into ubuntu-advantage-tools package to deliver the Ubuntu Pro Client CLI | -| uaclient.entitlements | Service-specific \*Entitlement class definitions which perform enable, disable, status, and entitlement operations etc. All classes derive from base.py:UAEntitlement and many derive from repo.py:RepoEntitlement | -| ./uaclient/cli.py | The entry-point for the command-line client -| ./uaclient/clouds/ | Cloud-platform detection logic used in Ubuntu Pro to determine if a given instance should be auto-attached to a contract | -| uaclient.contract | Module for interacting with the Contract Server API | -| uaclient.messages | Module that contains the messages delivered by `pro` to the user | -| uaclient.security | Module that hold the logic used to run `pro fix` commands | -| ./apt-hook/ | the C++ apt-hook delivering MOTD and apt command notifications about Ubuntu Pro support services | -| /etc/ubuntu-advantage/uaclient.conf | Configuration file for the Ubuntu Pro Client.| -| /var/lib/ubuntu-advantage/private | `root` read-only directory containing Contract API responses, machine-tokens and service credentials | -| /var/lib/ubuntu-advantage/machine-token.json | `world` readable file containing redacted Contract API responses, machine-tokens and service credentials | -| /var/log/ubuntu-advantage.log | `root` read-only log of ubuntu-advantage operations | - -## Note - -We have two `machine-token.json` files, located at: - -- /var/lib/ubuntu-advantage/private/machine-token.json -- /var/lib/ubuntu-advantage/machine-token.json - -The first file, located in the `private` directory, is root read-only. We have another world readable file in the `/var/lib/ubuntu-advantage` directory. - -The latter is currently being used when calling the `pro status` command as a non-root user. This file is redacted to remove any sensitive user data. diff --git a/dev-docs/references/enabling_a_service.md b/dev-docs/references/enabling_a_service.md deleted file mode 100644 index d799972d5b..0000000000 --- a/dev-docs/references/enabling_a_service.md +++ /dev/null @@ -1,21 +0,0 @@ -# Enabling a service - -Each service controlled by Ubuntu Pro Client will have a python module in -uaclient/entitlements/\*.py which handles setup and teardown of services when -enabled or disabled. - -If a contract entitles a machine to a service, `root` user can enable the -service with `pro enable `. If a service can be disabled -`pro disable ` will be permitted. - -The goal of the Ubuntu Pro Client is to remain simple and flexible and let the -contracts backend drive dynamic changes in contract offerings and constraints. -In pursuit of that goal, the Ubuntu Pro Client obtains most of it's service constraints -from a machine token that it obtains from the Contract Server API. - -The Ubuntu Pro Client is simple in that it relies on the machine token on the attached -machine to describe whether a service is applicable for an environment and what -configuration is required to properly enable that service. - -Any interactions with the Contract Server API are defined as UAContractClient -class methods in [uaclient/contract.py](../../uaclient/contract.py). diff --git a/dev-docs/references/terminology.md b/dev-docs/references/terminology.md deleted file mode 100644 index 0459eb7960..0000000000 --- a/dev-docs/references/terminology.md +++ /dev/null @@ -1,13 +0,0 @@ -# Terminology - -The following vocabulary is used to describe different aspects of the work -Ubuntu Pro Client performs: - -| Term | Meaning | -| -------- | -------- | -| Ubuntu Pro Client | The python command line client represented in this ubuntu-pro-client repository. It is installed on each Ubuntu machine and is the entry-point to enable any Ubuntu Pro commercial service on an Ubuntu machine | -| Contract Server | The backend service exposing a REST API to which Ubuntu Pro Client authenticates in order to obtain contract and commercial service information and manage which support services are active on a machine | -| Entitlement/Service | An Ubuntu Pro commercial support service such as FIPS, ESM, Livepatch, CIS-Audit to which a contract may be entitled | -| Affordance | Service-specific list of applicable architectures and Ubuntu series on which a service can run | -| Directives | Service-specific configuration values which are applied to a service when enabling that service | -| Obligations | Service-specific policies that must be instrumented for support of a service. Example: `enableByDefault: true` means that any attached machine **MUST** enable a service on attach |