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

Update access graph version and add Docker deployment warning #42002

Merged
merged 4 commits into from
May 30, 2024

Conversation

jakule
Copy link
Contributor

@jakule jakule commented May 24, 2024

The access graph version in the config.json file has been updated from 1.20.1 to 1.20.4. Also, a warning notice about Docker deployment suitability for testing and development purposes only has been added in the Docker deployment page.
Included instruction to make the tls keys readable after the default docker user has been changed.

Copy link

🤖 Vercel preview here: https://docs-a7shqqo20-goteleport.vercel.app/docs/ver/preview

@jakule jakule requested review from justinas, zmb3 and stevenGravy May 24, 2024 16:34
@jakule jakule marked this pull request as ready for review May 24, 2024 16:35
Copy link

The PR changelog entry failed validation: Changelog entry not found in the PR body. Please add a "no-changelog" label to the PR, or changelog lines starting with changelog: followed by the changelog entries for the PR.

Copy link

🤖 Vercel preview here: https://docs-mp4eloc8y-goteleport.vercel.app/docs/ver/preview

Copy link

The PR changelog entry failed validation: Changelog entry not found in the PR body. Please add a "no-changelog" label to the PR, or changelog lines starting with changelog: followed by the changelog entries for the PR.

@stevenGravy stevenGravy added the no-changelog Indicates that a PR does not require a changelog entry label May 24, 2024
- Starting from version 1.20.4 of the Access Graph service, the container by default runs as a non-root user.
Make sure the certificate files are readable by the user running the container. You can set correct permissions with the following command:
```console
$ sudo chown 65532 /path/to/tls.key
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: we use /etc/access_graph/tls.key as the path in the example config further below, so maybe use that here as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed

@@ -43,7 +54,7 @@ The host CA can be retrieved and saved into a file in one of the following ways:
```code
$ sudo mkdir /etc/access_graph
$ curl -s 'https://<Var name="teleport.example.com" />/webapi/auth/export?type=tls-host' | sudo tee /etc/access_graph/teleport_host_ca.pem
```
```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

unintended change?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed

@@ -29,8 +29,19 @@ to Teleport Enterprise customers.
- A TLS certificate for the Access Graph service
- The TLS certificate must be issued for "server authentication" key usage,
and must list the IP or DNS name of the TAG service in an X.509 v3 `subjectAltName` extension.
- Starting from version 1.20.4 of the Access Graph service, the container by default runs as a non-root user.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: "the container runs as a non-root user by default." might be a nicer phrasing?

jakule added 3 commits May 30, 2024 13:12
The access graph version in the config.json file has been updated from 1.20.1 to 1.20.4. Also, a warning notice about Docker deployment suitability for testing and development purposes only has been added in the Docker deployment page.
The Access Graph service documentation has been updated to reflect that containers now run as non-root users by default starting from version 1.20.4. Instructions have been amended to guide users on the necessary steps to ensure certificate files are readable by the new non-root user. Obsolete file permission tweaks were also removed.
The documentation for the Access-Graph service has been updated to clarify the information about non-root user and adjust the command-line path. It also includes corrections to some formatting issues for a better readability.
@jakule jakule force-pushed the jakule/tag-docker-warning branch from 850d8b0 to 776da77 Compare May 30, 2024 17:12
@jakule
Copy link
Contributor Author

jakule commented May 30, 2024

Friendly ping @r0mant @zmb3 @ptgott

Copy link

🤖 Vercel preview here: https://docs-edguudqnc-goteleport.vercel.app/docs/ver/preview

Co-authored-by: Paul Gottschling <[email protected]>
Copy link

🤖 Vercel preview here: https://docs-a0x3akul0-goteleport.vercel.app/docs/ver/preview

@jakule jakule added this pull request to the merge queue May 30, 2024
Merged via the queue into master with commit 242c514 May 30, 2024
38 checks passed
@jakule jakule deleted the jakule/tag-docker-warning branch May 30, 2024 18:49
@public-teleport-github-review-bot

@jakule See the table below for backport results.

Branch Result
branch/v14 Failed
branch/v15 Create PR
branch/v16 Create PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants