Skip to content
Open
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 33 additions & 27 deletions charts/tiles-api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,31 +125,37 @@ See the [documentation](https://docs.2gis.com/en/on-premise/map) to learn about:

### API Keys proxy settings

| Name | Description | Value |
| --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- |
| `proxy` | **Common settings** | |
| `proxy.logLevelOverride` | A custom proxy logging level. Allowed options: info|warn|debug|error. If not defined, default logLevel will be used. | `""` |
| `proxy.logFormatOverride` | A custom proxy logging format. Allowed options: text|json. If not defined, default logFormat will be used. | `""` |
| `proxy.containerPort` | Port the proxy listens on. | `5000` |
| `proxy.timeout` | Proxy timeout, in seconds. | `5s` |
| `proxy.resources` | **Kubernetes [resource management settings](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/)** | |
| `proxy.resources.requests.cpu` | A CPU request. | `50m` |
| `proxy.resources.requests.memory` | A memory request. | `128Mi` |
| `proxy.resources.limits.cpu` | A CPU limit. | `1` |
| `proxy.resources.limits.memory` | A memory limit. | `512Mi` |
| `proxy.image` | **Docker image settings** | |
| `proxy.image.repository` | Docker Repository. | `2gis-on-premise/tiles-api-proxy` |
| `proxy.image.tag` | Docker image tag. | `4.75.9` |
| `proxy.image.pullPolicy` | Kubernetes pull policy for the service's Docker image. | `IfNotPresent` |
| `proxy.access` | **API Keys service access settings** | |
| `proxy.access.enabled` | If access to the [API Keys service](https://docs.2gis.com/en/on-premise/keys) is enabled. | `false` |
| `proxy.access.url` | API Keys endpoint url, ex: http://keys-api.svc. **Required** | `""` |
| `proxy.access.syncPeriod` | Proxy sync period. | `2m` |
| `proxy.access.raster.token` | Service key for raster data in Keys API. Used for key validation. If Keys API is unavailable or token is empty/invalid, tile service will continue to work without key validation (with warning in logs). | `""` |
| `proxy.access.vector.token` | Service key for vector data in Keys API. Used for key validation. If Keys API is unavailable or token is empty/invalid, tile service will continue to work without key validation (with warning in logs). | `""` |
| `proxy.access.stat` | **Statistics receiver settings** | |
| `proxy.access.stat.enabled` | If statistics receiver is enabled. | `false` |
| `proxy.access.stat.url` | Statistics receiver endpoint url, ex: http(s)://host:port/path. **Required** | `""` |
| Name | Description | Value |
| ---------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- |
| `proxy` | **Common settings** | |
| `proxy.logLevelOverride` | A custom proxy logging level. Allowed options: info|warn|debug|error. If not defined, default logLevel will be used. | `""` |
| `proxy.logFormatOverride` | A custom proxy logging format. Allowed options: text|json. If not defined, default logFormat will be used. | `""` |
| `proxy.containerPort` | Port the proxy listens on. | `5000` |
| `proxy.timeout` | Proxy timeout, in seconds. | `5s` |
| `proxy.resources` | **Kubernetes [resource management settings](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/)** | |
| `proxy.resources.requests.cpu` | A CPU request. | `50m` |
| `proxy.resources.requests.memory` | A memory request. | `128Mi` |
| `proxy.resources.limits.cpu` | A CPU limit. | `1` |
| `proxy.resources.limits.memory` | A memory limit. | `512Mi` |
| `proxy.image` | **Docker image settings** | |
| `proxy.image.repository` | Docker Repository. | `2gis-on-premise/tiles-api-proxy` |
| `proxy.image.tag` | Docker image tag. | `4.75.9` |
| `proxy.image.pullPolicy` | Kubernetes pull policy for the service's Docker image. | `IfNotPresent` |
| `proxy.access` | **API Keys service access settings** | |
| `proxy.access.enabled` | If access to the [API Keys service](https://docs.2gis.com/en/on-premise/keys) is enabled. | `false` |
| `proxy.access.url` | API Keys endpoint url, ex: http://keys-api.svc. **Required** | `""` |
| `proxy.access.syncPeriod` | Proxy sync period. | `2m` |
| `proxy.access.raster.token` | Service key for raster data in Keys API. Used for key validation. If Keys API is unavailable or token is empty/invalid, tile service will continue to work without key validation (with warning in logs). | `""` |
| `proxy.access.vector.token` | Service key for vector data in Keys API. Used for key validation. If Keys API is unavailable or token is empty/invalid, tile service will continue to work without key validation (with warning in logs). | `""` |
| `proxy.access.skipExactOrigins` | **Skip requests with exact origins feature settings** | |
| `proxy.access.skipExactOrigins.enabled` | If enabled, only requests with exact origins will skip access key check, otherwise all requests will be checked. | `false` |
| `proxy.access.skipExactOrigins.regexpPattern` | Regular expression for matching origins that will skip access key check. **Required** | `""` |
| `proxy.access.stat` | **Statistics receiver settings** | |
| `proxy.access.stat.enabled` | If statistics receiver is enabled. | `false` |
| `proxy.access.stat.url` | Statistics receiver endpoint url, ex: http(s)://host:port/path. **Required** | `""` |
| `proxy.access.stat.registerExactHosts` | **Register requests to BSS for exact hosts feature settings** | |
| `proxy.access.stat.registerExactHosts.enabled` | If disabled, all requests will be registered in BSS, otherwise the only requests to exact hosts that matches regexp will be registered (hosts of tiles-api). | `false` |
| `proxy.access.stat.registerExactHosts.regexpPattern` | Regular expression for matching hosts that will be registered to statistics. **Required** | `""` |

### Tiles API settings

Expand Down Expand Up @@ -290,6 +296,6 @@ See the [documentation](https://docs.2gis.com/en/on-premise/map) to learn about:

## Maintainers

| Name | Email | Url |
| ---- | ------ | --- |
| Name | Email | Url |
| ---- | --------------------- | ------------------------- |
| 2gis | <[email protected]> | <https://github.com/2gis> |
6 changes: 6 additions & 0 deletions charts/tiles-api/configs/proxy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,12 @@ access:
{{- if .access.stat.enabled }}
host: {{ required "Valid .Values.proxy.access.stat.url required!" .access.stat.url }}
{{- end }}
register-exact-hosts:
enabled: {{ access.stat.registerExactHosts.enabled }}
regexp-pattern: {{ access.stat.registerExactHosts.regexpPattern | quote }}
skip-exact-origins:
enabled: {{ access.skipExactOrigins.enabled }}
regexp-pattern: {{ access.skipExactOrigins.regexpPattern | quote }}

storage:
enabled: false
Expand Down
18 changes: 18 additions & 0 deletions charts/tiles-api/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -237,10 +237,18 @@ tilegen:
# @param proxy.access.raster.token Service key for raster data in Keys API. Used for key validation. If Keys API is unavailable or token is empty/invalid, tile service will continue to work without key validation (with warning in logs).
# @param proxy.access.vector.token Service key for vector data in Keys API. Used for key validation. If Keys API is unavailable or token is empty/invalid, tile service will continue to work without key validation (with warning in logs).

# @extra proxy.access.skipExactOrigins **Skip requests with exact origins feature settings**
# @param proxy.access.skipExactOrigins.enabled If enabled, only requests with exact origins will skip access key check, otherwise all requests will be checked.
# @param proxy.access.skipExactOrigins.regexpPattern Regular expression for matching origins that will skip access key check. **Required**

# @extra proxy.access.stat **Statistics receiver settings**
# @param proxy.access.stat.enabled If statistics receiver is enabled.
# @param proxy.access.stat.url Statistics receiver endpoint url, ex: http(s)://host:port/path. **Required**

# @extra proxy.access.stat.registerExactHosts **Register requests to BSS for exact hosts feature settings**
# @param proxy.access.stat.registerExactHosts.enabled If disabled, all requests will be registered in BSS, otherwise the only requests to exact hosts that matches regexp will be registered (hosts of tiles-api).
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
# @extra proxy.access.stat.registerExactHosts **Register requests to BSS for exact hosts feature settings**
# @param proxy.access.stat.registerExactHosts.enabled If disabled, all requests will be registered in BSS, otherwise the only requests to exact hosts that matches regexp will be registered (hosts of tiles-api).
# @extra proxy.access.stat.registerExactHosts **Register requests to stat-receiver for exact hosts feature settings**
# @param proxy.access.stat.registerExactHosts.enabled If disabled, all requests will be registered in stat-receiver, otherwise the only requests to exact hosts that matches regexp will be registered (hosts of tiles-api).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Поправил, спасибо

# @param proxy.access.stat.registerExactHosts.regexpPattern Regular expression for matching hosts that will be registered to statistics. **Required**

proxy:
logLevelOverride: ''
logFormatOverride: ''
Expand Down Expand Up @@ -269,6 +277,16 @@ proxy:
enabled: false
url: ''

registerExactHosts:
enabled: false
# example: '^example\\.ru$'
regexpPattern: ''

skipExactOrigins:
enabled: false
# example: '^https://example\\.ru$'
regexpPattern: ''

vector:
token: ''
raster:
Expand Down
Loading