Add OCI tags docs #52405
+30
−0
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,30 @@ | ||||||
| --- | ||||||
| title: Oracle Cloud Tags as Teleport Agent Labels | ||||||
| description: How to set up Teleport agent labels based on Oracle Cloud labels | ||||||
| h1: Sync Oracle Cloud tags and Teleport agent labels | ||||||
| --- | ||||||
|
|
||||||
| When running on an Oracle Cloud (OCI) Compute instance, Teleport will | ||||||
| automatically detect and import the instance's freeform and defined tags | ||||||
| as Teleport labels for SSH nodes, applications, databases, and Kubernetes clusters. | ||||||
|
There was a problem hiding this comment. Do we prefer node or ssh server in user facing docs? cc @ptgott
Suggested change
|
||||||
| Tags imported this way will have the `oracle/` prefix. | ||||||
|
|
||||||
| When the Teleport process starts, it fetches all tags from OCI instance | ||||||
| metadata and adds them as labels. The instance's image must support IMDSv2. | ||||||
| The process will update the tags every hour, so newly created or deleted tags | ||||||
| will be reflected in the labels. | ||||||
|
Comment on lines
+7
to
+15
There was a problem hiding this comment. Should we note in this section that no additional permissions are required to be granted to the OCI instance? |
||||||
|
|
||||||
| If the freeform tag `teleporthostname` is present, its value (must be lower case) | ||||||
| will override the node's hostname. | ||||||
|
|
||||||
| ```code | ||||||
| $ tsh ls | ||||||
| Node Name Address Labels | ||||||
| -------------------- -------------- ------------------------------------------------------------------------------------------- | ||||||
| fakehost.example.com 127.0.0.1:3022 oracle/testing=yes,oracle/definedTagNamespace/environment=staging,oracle/teleporthostname=fakehost.example.com | ||||||
| ``` | ||||||
|
|
||||||
| <Notice type="note"> | ||||||
| For services that manage multiple resources (such as the Database Service), each resource will receive the | ||||||
| same tags from Oracle. | ||||||
| </Notice> | ||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The title uses
Teleport Agentthe description and h1 useTeleport agent. Let's be consistent across all three.