canonical / ubuntu-cloud-docs Goto Github PK

Public Docs for Ubuntu in the Clouds

CSS 25.00% Makefile 5.52% Python 55.02% Batchfile 1.08% JavaScript 1.70% HTML 8.68% Shell 3.01%

ubuntu-cloud-docs's Introduction

Ubuntu cloud documentation

Documentation for Ubuntu on public clouds. This documentation is composed of seven related documentation sets. The first one is for content related to public clouds in general and includes links to the remaining six. Five of the remaining six pertain to different cloud partners (AWS, Azure, IBM, Google cloud and Oracle cloud), while the last one is for container (OCI) registries.

Each documentation set is currently published to a different location:

How to work with this documentation

Download and install

Fork and clone this repository.

Once cloned, run:

make install

This invokes the install command in the Makefile, and creates a virtual environment (.sphinx/venv) and installs dependencies in .sphinx/requirements.txt.

A complete set of pinned, known-working dependencies is included in .sphinx/pinned-requirements.txt.

Build and serve the documentation

The make run command can be used to start the sphinx-autobuild documentation server. Since each cloud has it's own separate documentation set, you have to specify the required cloud name as a command line parameter. For example the command below will build and serve the documentation for AWS cloud:

PROJECT=aws make run

The different projects that can be specfied are 'all-clouds', 'aws', 'azure', 'google', 'ibm', 'oracle', 'oci' and 'public-images'.

The documentation will be available at 127.0.0.1:8000 or equivalently at localhost:8000.

The command:

activates the virtual environment and serves the documentation
rebuilds the documentation each time you save a file
sends a reload page signal to the browser when the documentation is rebuilt

(This is the most convenient way to work on the documentation, but you can still use the more standard make html. For instance, PROJECT=azure make html will create the azure related html pages in _build/azure.)

Check spelling

Run a spell check:

PROJECT=azure make spelling

If new words are to be added to the allowed list, update .custom_wordlist.txt accordingly.

Check links

Run a check for broken links:

PROJECT=google make linkcheck

Per project contribution guidelines

Each project has its own contribution guide: * All-clouds * AWS * Azure * Google * IBM * OCI container registries * Oracle * Public Images

ubuntu-cloud-docs's People

Contributors

Stargazers

Watchers

ubuntu-cloud-docs's Issues

docs: title is shadowed by a black box

Please describe the question or issue you're facing with "Create a chiselled Ubuntu image for C/C , Go and Rust applications - Ubuntu on OCI container registries documentation".

The title is shadowed by a black box. And the box is nothing but a link to "about:blank#blocked".

Reported from: https://documentation.ubuntu.com/oci-registries/en/latest/oci-how-to/create-chiselled-ubuntu-image/

docs: add --image-id resolve:ssm explanation while launching instances

From https://discourse.ubuntu.com/t/finding-ubuntu-images-with-the-aws-ssm-parameter-store/15507/10:

Good write up. I think it would be also of great value to add how to use with --image-id resolve:ssm:/<parameter-name> as indicated in AWS docs [here](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html).

EDIT: For use e.g. with 22.04 this is what I ended up with:

aws ec2 run-instances \                                                                                           254 ↵
    --image-id resolve:ssm:/aws/service/canonical/ubuntu/server/22.04/stable/current/amd64/hvm/ebs-gp2/ami-id \
    --instance-type g4dn.2xlarge

Reported from: https://documentation.ubuntu.com/aws/en/latest/aws-how-to/instances/find-ubuntu-images/

docs: make the AWS nvidia docs generic for AWS

Currently this seems to be for a specific nvidia driver version but there is ubuntu-drivers and that should be used to install the correct driver for different hardware.

Reported from: https://documentation.ubuntu.com/aws/en/latest/aws-how-to/instances/install-nvidia-drivers/

AWS customer-facing topics for inclusion: Unsupported, EOL, deprecated images

Some topics that are periodically/regularly surfaced by customer-facing teams:

Are EOL images removed from AWS? Will I still be able to launch images the day after the end-of-support? (might want to talk about EC2 deprecated flag, and how it's not something you control, and how to work around it)
Describe/point to docs that describe how to identify official Ubuntu images

I'm happy to contribute to the docs if desired. You know how to find me.

docs: re "AWS services"

The two main AWS services that use Ubuntu images are EC2 and EKS.

that doesn't sound good imo. EKS is just another service on AWS (beside the 100 other services they provide) and Canonical provides specific images for EKS (as we provide specific images for Workspaces)

Reported from: https://canonical-aws.readthedocs-hosted.com/en/latest/

docs: Canonical’s offerings on AWS

I don't see Pro listed as an offering in Canonical’s offerings on AWS. Why not?