You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# auth-gateway: Microservice that helps you administrating and operating your [Cortex](https://github.com/cortexproject/cortex) cluster in multi-tenant environments
9
+
# auth-gateway: Microservice that helps you debugistrating and operating your [Cortex](https://github.com/cortexproject/cortex) cluster in multi-tenant environments
10
10
11
-
`auth-gateway` is an entry point for all requests towards Cortex. This gateway is responsible for handling multi-tenancy features without complicated proxy configuration.
11
+
`auth-gateway` is an entry point for all requests towards Cortex.
12
+
This gateway is responsible for handling multi-tenancy features without complicated proxy configuration.
12
13
13
14
## What problem does `auth-gateway` solve?
14
15
15
-
When operating Cortex with numerous tenants, it's crucial to distinguish your tenants each time they make requests to a specific component. This differentiation is essential to ensure that each component processes its own requests independently.
16
+
When operating Cortex with numerous tenants, it's crucial to distinguish your tenants each time they make requests to a specific component.
17
+
This differentiation is essential to ensure that each component processes its own requests independently.
16
18
17
-
To achieve this, Cortex microservices necessitate the inclusion of a header named `X-Scope-OrgID` in each request. According to the Cortex Kubernetes (k8s) manifests, it's recommended to implement an NGINX server (eg. [nginx-config.yaml](https://github.com/cortexproject/cortex-helm-chart/blob/master/templates/nginx/nginx-config.yaml)) within each tenant's infrastructure, serving as a reverse proxy.
19
+
To achieve this, Cortex microservices necessitate the inclusion of a header named `X-Scope-OrgID` in each request.
20
+
According to the Cortex Kubernetes (k8s) manifests, it's recommended to implement an NGINX server (eg. [nginx-config.yaml](https://github.com/cortexproject/cortex-helm-chart/blob/master/templates/nginx/nginx-config.yaml)) within each tenant's infrastructure, serving as a reverse proxy.
18
21
19
-
The primary function of this server is to route the traffic and establish the `X-Scope-OrgID` header for the corresponding tenant. However, setting up an NGINX server for each tenant is complex and has limitations. For instance, you cannot define custom timeouts separately for each tenant.
22
+
The primary function of this server is to route the traffic and establish the `X-Scope-OrgID` header for the corresponding tenant
23
+
However, setting up an NGINX server for each tenant is complex and has limitations.
24
+
For instance, you cannot define custom timeouts separately for each tenant.
20
25
21
-
So, we created `auth-gateway`, a microservice that helps you administrating and operating your Cortex cluster in multi-tenant environments with just a simple configuration.
26
+
So, we created `auth-gateway`, a microservice that helps you debugistrating and operating your Cortex cluster in multi-tenant environments with just a simple configuration.
@@ -46,7 +51,7 @@ So, we created `auth-gateway`, a microservice that helps you administrating and
46
51
server: <server_config>
47
52
48
53
# A supporting server that exposes metrics, ready and pprof endpoints. Does not require authentication.
49
-
admin: <server_config>
54
+
debug: <server_config>
50
55
51
56
# List of all tenants that auth-gateway will serve.
52
57
tenants: <tenant_config>
@@ -91,7 +96,9 @@ The `tenant_config` configures the tenants.
91
96
```
92
97
93
98
### component_config
94
-
The `component_config` configures the components. Although the default timeout values are defined below, these default values differ depending on the component. To learn each component's timeout values, please refer to the [default timeout values](#default_timeout_values) section.
99
+
The `component_config` configures the components.
100
+
Although the default timeout values are defined below, these default values differ depending on the component.
101
+
To learn each component's timeout values, please refer to the [default timeout values](#default_timeout_values) section.
@@ -122,13 +130,15 @@ You can override these default values by specifying your desired timeout values
122
130
123
131
## Contributing
124
132
125
-
We welcome contributions. Please follow the [contributing guidelines](CONTRIBUTING.md).
133
+
We welcome contributions.
134
+
Please follow the [contributing guidelines](CONTRIBUTING.md).
126
135
127
136
## <a name="help"></a> Getting Help
128
137
129
138
If you have any questions about `auth-gateway`:
130
139
131
-
- Ask a question on the [Cortex Slack channel](https://cloud-native.slack.com/messages/cortex/). To invite yourself to the CNCF Slack, visit http://slack.cncf.io/.
140
+
- Ask a question on the [Cortex Slack channel](https://cloud-native.slack.com/messages/cortex/).
141
+
To invite yourself to the CNCF Slack, visit http://slack.cncf.io/.
132
142
- <a href="https://github.com/cortexproject/auth-gateway/issues/new">File an issue.</a>
0 commit comments