mirror of
https://github.com/gravitational/teleport.git
synced 2026-11-04 10:25:32 +08:00
Paul GottschlingandAlex Fornuto
da0e53ecdb
* Reorganize the config reference Closes #11253 This change breaks up the config reference by moving each Teleport service's configuration settings into a separate YAML snippet, and organizing each YAML snippet into a `TabItem` within a `Tabs` with `dropdownView` enabled. When Teleport Enterprise Cloud doesn't support a service, this change adds a `Notice` with a message about Teleport Enterprise Cloud in the relevant `TabItem`. I thought this approach would be cleaner than alternatives: - **Including an H2 for each service:** With this approach, the configuration reference would be even longer than it is now. With the approach I'm proposing, readers would navigate to "Reference configurations", then choose a service from a dropdown menu: much less scrolling for slightly more clicking. - **Including another set of `TabItem`s for Teleport editions:** I thought about adding a `Tabs` with a dropdown option for each Teleport edition and a horizontal `TabItem` for each service, but this would require horizontal scrolling and doesn't scale very well. - **Including horizontal tabs for each Teleport edition**, with an inner dropdown menu for each Teleport service: There is currently no way to do this without multiple `Tabs` components, which gets messy quickly. **Note** that this change does not attempt to copy-edit comments/example values within the configuration snippets. The scope of this change is limited only to reorganization. * Respond to PR feedback * Update docs/pages/includes/config-reference/instance-wide.yaml Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com> * Respond to PR feedback Use headings instead of `TabItem`s to split up sections of the config reference. --------- Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com>
41 lines
1.5 KiB
YAML
41 lines
1.5 KiB
YAML
app_service:
|
|
# Turns 'app' role on. Default is 'no'
|
|
enabled: yes
|
|
# Teleport contains a small debug app that can be used to make sure
|
|
# Application Access is working correctly. The app outputs JWTs so it can
|
|
# be useful when extending your application.
|
|
debug_app: true
|
|
apps:
|
|
- name: "kubernetes-dashboard"
|
|
# Optional: For access to cloud provider APIs, specify the cloud
|
|
# provider. Allowed values are "AWS", "Azure", and "GCP".
|
|
cloud: ""
|
|
# URI and Port of Application.
|
|
uri: "http://10.0.1.27:8000"
|
|
# Optionally skip TLS verification. default false
|
|
# insecure_skip_verify: true
|
|
# Optional Public Addr
|
|
public_addr: "example.com"
|
|
# Optional Label: These can be used in combination with RBAC rules
|
|
# to limit access to applications
|
|
labels:
|
|
env: "prod"
|
|
# Optional Dynamic Labels
|
|
commands:
|
|
- name: "os"
|
|
command: ["/usr/bin/uname"]
|
|
period: "5s"
|
|
## Optional list of rewrite rules to apply to requests and responses
|
|
# rewrite:
|
|
## Optional simple rewriting of Location header
|
|
## Rewrite the "Location" header on redirect responses replacing the
|
|
## host with the public address of this application.
|
|
# redirect:
|
|
# - "localhost"
|
|
# - "jenkins.internal.dev"
|
|
## Optional list of extra headers to inject in to requests.
|
|
# headers:
|
|
# For example:
|
|
# - "Host: jenkins.example.com"
|
|
|