status-im
/
consul
mirror of https://github.com/status-im/consul.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: Update Kubernetes YAML examples in UI visualization (#12419) 

* Update Kubernetes related YAML config examples to document supported
syntax in the latest version of the Helm chart.
* Fix syntax in JSON example configs.

Resolves #12403

Co-authored-by: mrspanishviking <kcardenas@hashicorp.com>
This commit is contained in:
Blake Covarrubias 2022-03-03 21:31:57 -08:00 committed by GitHub
parent 9268715697
commit 9a0c2dee60
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 134 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

173
website/content/docs/connect/observability/ui-visualization.mdx
View File

@ -66,7 +66,9 @@ service named `prometheus-server` so each Consul agent can reach it on
A full configuration to enable Prometheus is given below. A full configuration to enable Prometheus is given below.
<CodeTabs> <CodeTabs heading="UI metrics configuration" tabs={[ "HCL", "Kubernetes YAML", "JSON" ]}>
<CodeBlockConfig filename="agent-config.hcl">
```hcl ```hcl
ui_config { ui_config {
@ -78,25 +80,40 @@ ui_config {
} }
``` ```
</CodeBlockConfig>
<CodeBlockConfig filename="helm-values.yaml">
```yaml
ui:
enabled: true
metrics:
enabled: true # by default, this inherits from the value global.metrics.enabled
provider: "prometheus"
baseURL: http://prometheus-server
```
</CodeBlockConfig>
<CodeBlockConfig filename="agent-config.json">
```json ```json
{ {
"ui_config": [ "ui_config": {
{
"enabled": true, "enabled": true,
"metrics_provider": "prometheus", "metrics_provider": "prometheus",
"metrics_proxy": [ "metrics_proxy": {
{
"base_url": "http://prometheus-server" "base_url": "http://prometheus-server"
} }
]
} }
]
} }
``` ```
</CodeBlockConfig>
</CodeTabs> </CodeTabs>
Similarly, to configure the UI on Kubernetes, use this [reference](/docs/k8s/connect/observability/metrics). -> **Note**: For more information on configuring the observability UI on Kubernetes, use this [reference](/docs/k8s/connect/observability/metrics).
## Configuring Dashboard URLs ## Configuring Dashboard URLs
@ -115,9 +132,9 @@ to the relevant information.
An example with Grafana is shown below. An example with Grafana is shown below.
<CodeTabs tabs={[ "HCL", "JSON", "YAML (Kubernetes)" ]}> <CodeTabs heading="Example dashboard URL template configuration for UI visualization" tabs={[ "HCL", "Kubernetes YAML", "JSON" ]}>
<CodeBlockConfig> <CodeBlockConfig filename="agent-config.hcl">
```hcl ```hcl
ui_config { ui_config {
@ -130,31 +147,19 @@ ui_config {
</CodeBlockConfig> </CodeBlockConfig>
<CodeBlockConfig> <CodeBlockConfig filename="helm-values.yaml">
```json
{
"ui_config": [
{
"dashboard_url_templates": [
{
"service": "https://grafana.example.com/d/lDlaj-NGz/service-overview?orgId=1\u0026var-service={{Service.Name}}\u0026var-namespace={{Service.Namespace}}\u0026var-partition={{Service.Partition}}\u0026var-dc={{Datacenter}}"
}
],
"enabled": true
}
]
}
```
</CodeBlockConfig>
<CodeBlockConfig>
```yaml ```yaml
# The UI is enabled by default so this stanza is not required. # The UI is enabled by default so this stanza is not required.
ui: ui:
enabled: true enabled: true
# This configuration requires version 0.40.0 or later of the Helm chart.
dashboardURLTemplates:
service: "https://grafana.example.com/d/lDlaj-NGz/service-overview?orgId=1&var-service={{Service.Name}}&var-namespace={{Service.Namespace}}&var-dc={{Datacenter}}"
# If you are using a version of the Helm chart older than 0.40.0, you must
# configure the dashboard URL template using the `server.extraConfig` parameter
# in the Helm chart's values file.
server: server:
extraConfig: | extraConfig: |
{ {
@ -168,11 +173,26 @@ server:
</CodeBlockConfig> </CodeBlockConfig>
<CodeBlockConfig filename="agent-config.json">
```json
{
"ui_config": {
"enabled": true,
"dashboard_url_templates": {
"service": "https://grafana.example.com/d/lDlaj-NGz/service-overview?orgId=1\u0026var-service={{Service.Name}}\u0026var-namespace={{Service.Namespace}}\u0026var-partition={{Service.Partition}}\u0026var-dc={{Datacenter}}"
}
}
}
```
</CodeBlockConfig>
</CodeTabs> </CodeTabs>
~> **Note**: On Kubernetes, Consul Server configuration is set in your Helm ~> **Note**: On Kubernetes, the Consul Server configuration set in the Helm config's
config via the [`server.extraConfig`](/docs/k8s/helm#v-server-extraconfig) key as JSON. [`server.extraConfig`](/docs/k8s/helm#v-server-extraconfig) key must be specified
The `{{` characters in the URL must be escaped using `{{ "{{" }}` so that Helm as JSON. The `{{` characters in the URL must be escaped using `{{ "{{" }}` so that Helm
doesn't try to template them. doesn't try to template them.
![Consul UI Service Dashboard Link](/img/ui-dashboard-url-template.png) ![Consul UI Service Dashboard Link](/img/ui-dashboard-url-template.png)
@ -206,18 +226,42 @@ un-authenticated workloads on the network**.
With ACLs enabled, the proxy endpoint requires a valid token with read access With ACLs enabled, the proxy endpoint requires a valid token with read access
to all nodes and services (across all namespaces in Enterprise): to all nodes and services (across all namespaces in Enterprise):
<CodeTabs> <Tabs>
<Tab heading="Consul OSS">
<CodeTabs heading="Example policy granting read-only access to all services and nodes">
```hcl ```hcl
# Consul OSS
service_prefix "" { service_prefix "" {
policy = "read" policy = "read"
} }
node_prefix "" { node_prefix "" {
policy = "read" policy = "read"
} }
```
# Consul Enterprise ```json
{
"service_prefix": {
"": {
"policy": "read"
}
},
"node_prefix": {
"": {
"policy": "read"
}
}
}
```
</CodeTabs>
</Tab>
<Tab heading="Consul Enterprise">
<CodeTabs heading="Example policy granting read-only access to all services and nodes across all namespaces">
```hcl
namespace_prefix "" { namespace_prefix "" {
service_prefix "" { service_prefix "" {
policy = "read" policy = "read"
@ -228,8 +272,30 @@ namespace_prefix "" {
} }
``` ```
```json
{
"namespace_prefix": {
"": {
"service_prefix": {
"": {
"policy": "read"
}
},
"node_prefix": {
"": {
"policy": "read"
}
}
}
}
}
```
</CodeTabs> </CodeTabs>
</Tab>
</Tabs>
It's typical for most authenticated users to have this level of access in Consul It's typical for most authenticated users to have this level of access in Consul
as it's required for viewing the catalog or discovering services. If you use a as it's required for viewing the catalog or discovering services. If you use a
[Single Sign-On integration](/docs/security/acl/auth-methods/oidc) (Consul [Single Sign-On integration](/docs/security/acl/auth-methods/oidc) (Consul
@ -274,7 +340,9 @@ visible to Consul operators in the configuration file while UI users can query
the metrics they need without separately obtaining a token for that provider or the metrics they need without separately obtaining a token for that provider or
having a token exposed to them that they might be able to use elsewhere. having a token exposed to them that they might be able to use elsewhere.
<CodeTabs> <CodeTabs heading="Example configuration to add additional HTTP headers to the metrics endpoint">
<CodeBlockConfig filename="agent-config.hcl">
```hcl ```hcl
ui_config { ui_config {
@ -292,28 +360,30 @@ ui_config {
} }
``` ```
</CodeBlockConfig>
<CodeBlockConfig filename="agent-config.json">
```json ```json
{ {
"ui_config": [ "ui_config": {
{
"enabled": true, "enabled": true,
"metrics_provider": "example-apm", "metrics_provider": "example-apm",
"metrics_proxy": [ "metrics_proxy": {
{ "base_url": "https://example-apm.com/api/v1/metrics",
"add_headers": [ "add_headers": [
{ {
"name": "Authorization", "name": "Authorization",
"value": "Bearer \u003ctoken\u003e" "value": "Bearer \u003ctoken\u003e"
} }
],
"base_url": "https://example-apm.com/api/v1/metrics"
}
] ]
} }
] }
} }
``` ```
</CodeBlockConfig>
</CodeTabs> </CodeTabs>
## Custom Metrics Providers ## Custom Metrics Providers
@ -331,9 +401,9 @@ feedback on [GitHub](https://github.com/hashicorp/consul) or
The template for a complete provider JavaScript file is given below. The template for a complete provider JavaScript file is given below.
<CodeTabs> <CodeTabs heading="Example JavaScript class template for a custom metrics plugin">
```JavaScript ```javascript
(function () { (function () {
var provider = { var provider = {
/** /**
@ -553,7 +623,9 @@ named `example-provider`, which is defined in
have been specified in the call to `consul.registerMetricsProvider` as in the have been specified in the call to `consul.registerMetricsProvider` as in the
code listing in the last section. code listing in the last section.
<CodeTabs> <CodeTabs heading="Example configuration using a custom metrics provider">
<CodeBlockConfig filename="agent-config.hcl">
```hcl ```hcl
ui_config { ui_config {
@ -568,6 +640,10 @@ ui_config {
} }
``` ```
</CodeBlockConfig>
<CodeBlockConfig filename="agent-config.json">
```json ```json
{ {
"ui_config": { "ui_config": {
@ -579,6 +655,7 @@ ui_config {
} }
``` ```
</CodeBlockConfig>
</CodeTabs> </CodeTabs>
More than one JavaScript file may be specified in More than one JavaScript file may be specified in