From 4d488319ef5bfa3405cdce34f5c4ec2d5d16cf08 Mon Sep 17 00:00:00 2001 From: Sam Berning Date: Wed, 14 Feb 2024 20:30:12 +0000 Subject: [PATCH 1/5] api-driven: fix typo equlivent -> equivalent Signed-off-by: Sam Berning --- content/en/os/1.19.x/concepts/api-driven/index.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/os/1.19.x/concepts/api-driven/index.markdown b/content/en/os/1.19.x/concepts/api-driven/index.markdown index 4ea10512..ea77b6bc 100644 --- a/content/en/os/1.19.x/concepts/api-driven/index.markdown +++ b/content/en/os/1.19.x/concepts/api-driven/index.markdown @@ -82,7 +82,7 @@ As an example: host-containers.admin.enabled=false ``` -The above key/value format is equlivent to: +The above key/value format is equivalent to: ```json { "host-containers" : { "admin" : { "enabled": false } } } From 2b9f68f49eefbdfe4869610aab744acf164113a5 Mon Sep 17 00:00:00 2001 From: "Kyle J. Davis" Date: Fri, 16 Feb 2024 12:45:27 -0700 Subject: [PATCH 2/5] fix SSM in concepts on 1.15.x to 1.19.x --- content/en/os/1.15.x/concepts/host-containers/_index.markdown | 2 +- content/en/os/1.16.x/concepts/host-containers/_index.markdown | 2 +- content/en/os/1.17.x/concepts/host-containers/_index.markdown | 2 +- content/en/os/1.18.x/concepts/host-containers/_index.markdown | 2 +- content/en/os/1.19.x/concepts/host-containers/_index.markdown | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/content/en/os/1.15.x/concepts/host-containers/_index.markdown b/content/en/os/1.15.x/concepts/host-containers/_index.markdown index 7a56c68d..98c7f01f 100644 --- a/content/en/os/1.15.x/concepts/host-containers/_index.markdown +++ b/content/en/os/1.15.x/concepts/host-containers/_index.markdown @@ -20,7 +20,7 @@ Instead you manage the lifecycle of these containers by manipulating specific {{ ## Built-in host containers Depending on the variant, Bottlerocket has two standard host containers: the {{< ver-ref project="os" page="/install/quickstart/aws/host-containers#interacting-with-a-bottlerocket-node-through-host-containers" >}}control container{{< /ver-ref >}} and the {{< ver-ref project="os" page="/install/quickstart/aws/host-containers#exploring-the-admin-container" >}}admin container{{< /ver-ref >}}. -The control container provides a pathway to connect ([via SMM](https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-agent.html)) to and interact with the host as well as conveniently access the Bottlerocket API. +The control container provides a pathway to connect ([via SSM](https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-agent.html)) to and interact with the host as well as conveniently access the Bottlerocket API. The control container also provides an entry point to the admin container. The admin container allows you to more deeply interact with the host as it mounts the root filesystem and has elevated privileges. diff --git a/content/en/os/1.16.x/concepts/host-containers/_index.markdown b/content/en/os/1.16.x/concepts/host-containers/_index.markdown index f8443a8d..75d1db21 100644 --- a/content/en/os/1.16.x/concepts/host-containers/_index.markdown +++ b/content/en/os/1.16.x/concepts/host-containers/_index.markdown @@ -20,7 +20,7 @@ Instead you manage the lifecycle of these containers by manipulating specific {{ ## Built-in host containers Depending on the variant, Bottlerocket has two standard host containers: the {{< ver-ref project="os" page="/install/quickstart/aws/host-containers#interacting-with-a-bottlerocket-node-through-host-containers" >}}control container{{< /ver-ref >}} and the {{< ver-ref project="os" page="/install/quickstart/aws/host-containers#exploring-the-admin-container" >}}admin container{{< /ver-ref >}}. -The control container provides a pathway to connect ([via SMM](https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-agent.html)) to and interact with the host as well as conveniently access the Bottlerocket API. +The control container provides a pathway to connect ([via SSM](https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-agent.html)) to and interact with the host as well as conveniently access the Bottlerocket API. The control container also provides an entry point to the admin container. The admin container allows you to more deeply interact with the host as it mounts the root filesystem and has elevated privileges. diff --git a/content/en/os/1.17.x/concepts/host-containers/_index.markdown b/content/en/os/1.17.x/concepts/host-containers/_index.markdown index f8443a8d..75d1db21 100644 --- a/content/en/os/1.17.x/concepts/host-containers/_index.markdown +++ b/content/en/os/1.17.x/concepts/host-containers/_index.markdown @@ -20,7 +20,7 @@ Instead you manage the lifecycle of these containers by manipulating specific {{ ## Built-in host containers Depending on the variant, Bottlerocket has two standard host containers: the {{< ver-ref project="os" page="/install/quickstart/aws/host-containers#interacting-with-a-bottlerocket-node-through-host-containers" >}}control container{{< /ver-ref >}} and the {{< ver-ref project="os" page="/install/quickstart/aws/host-containers#exploring-the-admin-container" >}}admin container{{< /ver-ref >}}. -The control container provides a pathway to connect ([via SMM](https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-agent.html)) to and interact with the host as well as conveniently access the Bottlerocket API. +The control container provides a pathway to connect ([via SSM](https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-agent.html)) to and interact with the host as well as conveniently access the Bottlerocket API. The control container also provides an entry point to the admin container. The admin container allows you to more deeply interact with the host as it mounts the root filesystem and has elevated privileges. diff --git a/content/en/os/1.18.x/concepts/host-containers/_index.markdown b/content/en/os/1.18.x/concepts/host-containers/_index.markdown index f8443a8d..75d1db21 100644 --- a/content/en/os/1.18.x/concepts/host-containers/_index.markdown +++ b/content/en/os/1.18.x/concepts/host-containers/_index.markdown @@ -20,7 +20,7 @@ Instead you manage the lifecycle of these containers by manipulating specific {{ ## Built-in host containers Depending on the variant, Bottlerocket has two standard host containers: the {{< ver-ref project="os" page="/install/quickstart/aws/host-containers#interacting-with-a-bottlerocket-node-through-host-containers" >}}control container{{< /ver-ref >}} and the {{< ver-ref project="os" page="/install/quickstart/aws/host-containers#exploring-the-admin-container" >}}admin container{{< /ver-ref >}}. -The control container provides a pathway to connect ([via SMM](https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-agent.html)) to and interact with the host as well as conveniently access the Bottlerocket API. +The control container provides a pathway to connect ([via SSM](https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-agent.html)) to and interact with the host as well as conveniently access the Bottlerocket API. The control container also provides an entry point to the admin container. The admin container allows you to more deeply interact with the host as it mounts the root filesystem and has elevated privileges. diff --git a/content/en/os/1.19.x/concepts/host-containers/_index.markdown b/content/en/os/1.19.x/concepts/host-containers/_index.markdown index f8443a8d..75d1db21 100644 --- a/content/en/os/1.19.x/concepts/host-containers/_index.markdown +++ b/content/en/os/1.19.x/concepts/host-containers/_index.markdown @@ -20,7 +20,7 @@ Instead you manage the lifecycle of these containers by manipulating specific {{ ## Built-in host containers Depending on the variant, Bottlerocket has two standard host containers: the {{< ver-ref project="os" page="/install/quickstart/aws/host-containers#interacting-with-a-bottlerocket-node-through-host-containers" >}}control container{{< /ver-ref >}} and the {{< ver-ref project="os" page="/install/quickstart/aws/host-containers#exploring-the-admin-container" >}}admin container{{< /ver-ref >}}. -The control container provides a pathway to connect ([via SMM](https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-agent.html)) to and interact with the host as well as conveniently access the Bottlerocket API. +The control container provides a pathway to connect ([via SSM](https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-agent.html)) to and interact with the host as well as conveniently access the Bottlerocket API. The control container also provides an entry point to the admin container. The admin container allows you to more deeply interact with the host as it mounts the root filesystem and has elevated privileges. From 40acd332cffcc54286c8e93c43fac399d2bd53f5 Mon Sep 17 00:00:00 2001 From: "Kyle J. Davis" Date: Fri, 16 Feb 2024 13:05:15 -0700 Subject: [PATCH 3/5] changes link to AmazonECS_FullAccess --- content/en/os/1.19.x/install/quickstart/aws/ecs/index.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/os/1.19.x/install/quickstart/aws/ecs/index.markdown b/content/en/os/1.19.x/install/quickstart/aws/ecs/index.markdown index 894b93d5..4e692c57 100644 --- a/content/en/os/1.19.x/install/quickstart/aws/ecs/index.markdown +++ b/content/en/os/1.19.x/install/quickstart/aws/ecs/index.markdown @@ -18,7 +18,7 @@ There are some preliminary tasks to complete in order to use ECS. You need to both set up your AWS account for use with ECS and have an IAM role for ECS configured: - Complete the steps in [Setting up with Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/get-set-up-for-amazon-ecs.html). -- Ensure that the AWS user you use for this quickstart has the permissions specified in the [Amazon ECS First Run Wizard Permissions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/security_iam_id-based-policy-examples.html#first-run-permissions) IAM policy example. +- Ensure that the AWS user you use for this quickstart has the has the [AmazonECS_FullAccess](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/security-iam-awsmanpol.html#security-iam-awsmanpol-AmazonECS_FullAccess) policy attached (scope down as needed for your production requirements). - Ensure that you have an [IAM role created](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/instance_IAM_role.html#instance-iam-role-create) named `ecsInstanceRole` and configured according to the AWS ECS Developer Guide. - Be sure to follow _both_ the [AWS Console steps](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/instance_IAM_role.html#instance-iam-role-create) as well as the AWS CLI steps (section labeled "To create the ecsInstanceRole role (AWS CLI)" - the AWS CLI steps cover an important aspect: adding an Instance Profile to the role) From a231a6859a423ae1d3f8bd6a3a9fabca3b87d3d8 Mon Sep 17 00:00:00 2001 From: "Kyle J. Davis" Date: Fri, 16 Feb 2024 13:57:06 -0700 Subject: [PATCH 4/5] better linking for brupop --- content/en/_index.markdown | 8 ++++++-- content/en/os/_index.markdown | 9 +++++++-- 2 files changed, 13 insertions(+), 4 deletions(-) diff --git a/content/en/_index.markdown b/content/en/_index.markdown index 979988ed..9efd1eac 100644 --- a/content/en/_index.markdown +++ b/content/en/_index.markdown @@ -21,11 +21,15 @@ However, the most fundamental building blocks needed to understand Bottlerocket ## Organization This documentation is divided by project and largely mirrors the repository boundaries of the Bottlerocket GitHub organization. -The primary documentation for the operating system is in the OS section and correlates with `bottlerocket-os/bottlerocket` on GitHub. + +| GitHub Repo | Section | Description | +|-------------|---------------|-------------| +| [`bottlerocket-os/bottlerocket`](https://github.com/bottlerocket-os/bottlerocket) | [OS](./os/) | Primary documentation for the operating system. | +| [`bottlerocket-os/bottlerocket-update-operator`](https://github.com/bottlerocket-os/bottlerocket-update-operator) | [Brupop](./os/) | Documentation for the Kubernetes operator that automates Bottlerocket updates | Inside each section, the documentation is further scoped to minor versions of each project with the most recent release being marked as (*Current*). -Version Information sections contain reference metadata about the documented release. +Where available, **Version Information** sections contain reference metadata about the documented release. ## Navigation diff --git a/content/en/os/_index.markdown b/content/en/os/_index.markdown index 58b1ae8e..531683e7 100644 --- a/content/en/os/_index.markdown +++ b/content/en/os/_index.markdown @@ -7,7 +7,8 @@ no_version_warning=true weight=2 +++ -This section covers installing and using the Bottlerocket operating system[^1]. If you’re looking for information on building, contributing to, or learning about the inner workings of Bottlerocket, the [GitHub repo](https://github.com/bottlerocket-os/bottlerocket) has more information. +This section covers installing and using the **Bottlerocket operating system**. +If you’re looking for information on building, contributing to, or learning about the inner workings of Bottlerocket, the [GitHub repo](https://github.com/bottlerocket-os/bottlerocket) has more information. ## Organization @@ -17,8 +18,12 @@ The current documented versions: {{< subsections-list >}} +## Related Projects + +Non-OS Bottlerocket projects are covered in other sections ([Bottlerocket Update Operator documentation](../brupop/)) or on their respective GitHub Repos[^1] ([Control Container](https://github.com/bottlerocket-os/bottlerocket-control-container), [Admin Container](https://github.com/bottlerocket-os/bottlerocket-admin-container), [Bottlerocket ECS Updater](https://github.com/bottlerocket-os/bottlerocket-ecs-updater), etc.) + ## Something Missing? Bottlerocket, like any operating system, is complex and rich with options and configuration. This [documentation is open-source](https://github.com/bottlerocket-os/project-website) and likely incomplete, but will evolve over time to encompass a more complete explanation of the software. Should you find gaps, you’re invited to file issues or contribute. -[^1]: Documentation for projects related to Bottlerocket (such as the Control Container, Admin Container, brupop, etc.) are not present in this documentation and still reside in their respective GitHub repos. In the future, documentation on the use and installation of these tools will migrate to a new section on this site. +[^1]: In the future, documentation on the use and installation of these tools may migrate to a new section on this site. From 7eb4709aa85b23dec45166cfe72420f121999230 Mon Sep 17 00:00:00 2001 From: "Kyle J. Davis" Date: Fri, 16 Feb 2024 14:04:51 -0700 Subject: [PATCH 5/5] fix linking on homepage --- content/en/_index.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/_index.markdown b/content/en/_index.markdown index 9efd1eac..9e6182e2 100644 --- a/content/en/_index.markdown +++ b/content/en/_index.markdown @@ -25,7 +25,7 @@ This documentation is divided by project and largely mirrors the repository boun | GitHub Repo | Section | Description | |-------------|---------------|-------------| | [`bottlerocket-os/bottlerocket`](https://github.com/bottlerocket-os/bottlerocket) | [OS](./os/) | Primary documentation for the operating system. | -| [`bottlerocket-os/bottlerocket-update-operator`](https://github.com/bottlerocket-os/bottlerocket-update-operator) | [Brupop](./os/) | Documentation for the Kubernetes operator that automates Bottlerocket updates | +| [`bottlerocket-os/bottlerocket-update-operator`](https://github.com/bottlerocket-os/bottlerocket-update-operator) | [Brupop](./brupop/) | Documentation for the Kubernetes operator that automates Bottlerocket updates | Inside each section, the documentation is further scoped to minor versions of each project with the most recent release being marked as (*Current*).