Skip to content

Commit

Permalink
Merge pull request #431 from bottlerocket-os/main
Browse files Browse the repository at this point in the history
Move to Prod: Variety of content tweaks (typos, linking)
  • Loading branch information
stockholmux authored Feb 16, 2024
2 parents 9adf06f + 983f7c6 commit 347c116
Show file tree
Hide file tree
Showing 9 changed files with 20 additions and 11 deletions.
8 changes: 6 additions & 2 deletions content/en/_index.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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](./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*).

Version Information sections contain reference metadata about the documented release.
Where available, **Version Information** sections contain reference metadata about the documented release.

## Navigation

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion content/en/os/1.19.x/concepts/api-driven/index.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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 } } }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
9 changes: 7 additions & 2 deletions content/en/os/_index.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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.

0 comments on commit 347c116

Please sign in to comment.