Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README: mention 'enter-admin-container' where appropriate #2028

Merged
merged 1 commit into from
Mar 30, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,10 +134,10 @@ aws ssm start-session --target INSTANCE_ID

With the [default control container](https://github.com/bottlerocket-os/bottlerocket-control-container), you can make [API calls](#api) to configure and manage your Bottlerocket host.
To do even more, read the next section about the [admin container](#admin-container).
If you've enabled the admin container, you can access it from the control container like this:
You can access the admin container from the control container like this:

```
apiclient exec admin bash
enter-admin-container
```

### Admin container
Expand All @@ -160,13 +160,19 @@ If Bottlerocket is already running, you can enable the admin container from the
enable-admin-container
```

Or you can start an interactive session immediately like this:

```
enter-admin-container
```

If you're using a custom control container, or want to make the API calls directly, you can enable the admin container like this instead:

```
apiclient set host-containers.admin.enabled=true
```

Once you've enabled the admin container, you can either access it through SSH or from the control container like this:
Once you've enabled the admin container, you can either access it through SSH or execute commands from the control container like this:

```
apiclient exec admin bash
Expand Down Expand Up @@ -508,8 +514,8 @@ These settings will configure the proxying behavior of the following services:
* [ecs.service](packages/ecs-agent/ecs.service)

* `settings.network.https-proxy`: The HTTPS proxy server to be used by services listed above.
* `settings.network.no-proxy`: A list of hosts that are excluded from proxying.
Example:
* `settings.network.no-proxy`: A list of hosts that are excluded from proxying.
Example:
```
[settings.network]
https-proxy = "1.2.3.4:8080"
Expand Down