Skip to content

DM-54497: Enable setting output limit for TAP capabilities per environment #6287

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
stvoutsin wants to merge 1 commit into
base: main
Choose a base branch
from
Open

DM-54497: Enable setting output limit for TAP capabilities per environment #6287

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions applications/tap/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ IVOA TAP service
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| cadc-tap.config.backend | string | `"qserv"` | What type of backend? |
| cadc-tap.config.outputLimit | string | `"3221225472"` | 3GB byte limit for Qserv |
| cadc-tap.config.outputLimitUnit | string | `"byte"` | |
| cadc-tap.config.sentryEnabled | bool | `false` | Whether Sentry is enabled in this environment |
| cadc-tap.config.serviceName | string | `"tap"` | Name of the service from Gafaelfawr's perspective |
| cadc-tap.config.vaultSecretName | string | `"tap"` | Vault secret name: the final key in the vault path |
Expand Down
4 changes: 4 additions & 0 deletions applications/tap/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ cadc-tap:
# -- Whether Sentry is enabled in this environment
sentryEnabled: false

# -- 3GB byte limit for Qserv
outputLimit: "3221225472"
outputLimitUnit: "byte"

serviceAccount:
# -- Name of the Kubernetes `ServiceAccount`, used for CloudSQL access
name: "tap"
Expand Down
9 changes: 6 additions & 3 deletions charts/cadc-tap/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ IVOA TAP service
| config.bigquery.dataset | string | None, must be set if backend is `bigquery` | BigQuery dataset name |
| config.bigquery.image.pullPolicy | string | `"IfNotPresent"` | Pull policy for the TAP image |
| config.bigquery.image.repository | string | `"ghcr.io/lsst-sqre/lsst-tap-service"` | TAP image to use |
| config.bigquery.image.tag | string | `"3.16.0"` | Tag of TAP image to use |
| config.bigquery.image.tag | string | `"3.17.0"` | Tag of TAP image to use |
| config.bigquery.project | string | None, must be set if backend is `bigquery` | BigQuery project ID |
| config.bigquery.schema | string | `""` | Schema name for table mappings (optional) |
| config.database | string | `"dp02"` | Data Database name |
Expand All @@ -42,6 +42,9 @@ IVOA TAP service
| config.kafka.topics.jobDelete | string | `"lsst.tap.job-delete"` | Job Delete topic |
| config.kafka.topics.jobRun | string | `"lsst.tap.job-run"` | Job Run topic |
| config.kafka.topics.jobStatus | string | `"lsst.tap.job-status"` | Job Status topic |
| config.maxRec | string | `""` | Maximum row limit (MAXREC) enforced server-side. Leave empty to use the default (100000000). |
| config.outputLimit | string | `""` | Output limit value for TAP queries advertised in capabilities. Leave empty to use the default (100000000). |
| config.outputLimitUnit | string | `""` | Unit for the output limit: "byte" or "row". Leave empty to use the default ("row"). |
| config.pg.database | string | None, must be set if backend is `pg` | Database to connect to |
| config.pg.host | string | None, must be set if backend is `pg` | Host to connect to |
| config.pg.image.pullPolicy | string | `"IfNotPresent"` | Pull policy for the TAP image |
Expand All @@ -51,7 +54,7 @@ IVOA TAP service
| config.qserv.host | string | `"mock-db:3306"` (the mock QServ) | QServ hostname:port to connect to |
| config.qserv.image.pullPolicy | string | `"IfNotPresent"` | Pull policy for the TAP image |
| config.qserv.image.repository | string | `"ghcr.io/lsst-sqre/lsst-tap-service"` | TAP image to use |
| config.qserv.image.tag | string | `"3.16.0"` | Tag of TAP image to use |
| config.qserv.image.tag | string | `"3.17.0"` | Tag of TAP image to use |
| config.qserv.jdbcParams | string | `""` | Extra JDBC connection parameters |
| config.qserv.passwordEnabled | bool | false | Whether the Qserv database is password protected |
| config.sentryEnabled | bool | `false` | Whether Sentry is enabled in this environment |
Expand Down Expand Up @@ -115,7 +118,7 @@ IVOA TAP service
| uws.external.port | int | `5432` | Port of external PostgreSQL server |
| uws.image.pullPolicy | string | `"IfNotPresent"` | Pull policy for the UWS database image |
| uws.image.repository | string | `"ghcr.io/lsst-sqre/lsst-tap-uws-db"` | UWS database image to use |
| uws.image.tag | string | `"3.16.0"` | Tag of UWS database image to use |
| uws.image.tag | string | `"3.17.0"` | Tag of UWS database image to use |
| uws.maxActive | int | `5` | Maximum active connections (maxIdle will be set to this value) |
| uws.nodeSelector | object | `{}` | Node selection rules for the UWS database pod |
| uws.podAnnotations | object | `{}` | Annotations for the UWS databse pod |
Expand Down
9 changes: 9 additions & 0 deletions charts/cadc-tap/templates/tap-deployment.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,15 @@ spec:
-Dkafka.status.topic={{ .Values.config.kafka.topics.jobStatus }}
-Dkafka.delete.topic={{ .Values.config.kafka.topics.jobDelete }}
{{- end }}
{{- if .Values.config.outputLimit }}
-Dtap.outputLimit={{ .Values.config.outputLimit }}
{{- end }}
{{- if .Values.config.outputLimitUnit }}
-Dtap.outputLimitUnit={{ .Values.config.outputLimitUnit }}
{{- end }}
{{- if .Values.config.maxRec }}
-Dtap.maxRec={{ .Values.config.maxRec }}
{{- end }}
-Dbase_url={{ .Values.global.baseUrl }}
-Dpath_prefix=/api/{{ .Values.ingress.path }}
-Dca.nrc.cadc.util.PropertiesReader.dir=/config/
Expand Down
18 changes: 15 additions & 3 deletions charts/cadc-tap/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ config:
pullPolicy: "IfNotPresent"

# -- Tag of TAP image to use
tag: "3.16.0"
tag: "3.17.0"

# -- Whether the Qserv database is password protected
# @default -- false
Expand All @@ -120,7 +120,7 @@ config:
pullPolicy: "IfNotPresent"

# -- Tag of TAP image to use
tag: "3.16.0"
tag: "3.17.0"

# -- Address to a MySQL database containing TAP schema data
tapSchemaAddress: "cadc-tap-schema-db:3306"
Expand Down Expand Up @@ -183,6 +183,18 @@ config:
# -- Whether kafka is enabled
enabled: false

# -- Output limit value for TAP queries advertised in capabilities.
# Leave empty to use the default (100000000).
outputLimit: ""

# -- Unit for the output limit: "byte" or "row".
# Leave empty to use the default ("row").
outputLimitUnit: ""

# -- Maximum row limit (MAXREC) enforced server-side.
# Leave empty to use the default (100000000).
maxRec: ""

# -- Rules for renaming Columns
urlRewrite:

Expand Down Expand Up @@ -343,7 +355,7 @@ uws:
pullPolicy: "IfNotPresent"

# -- Tag of UWS database image to use
tag: "3.16.0"
tag: "3.17.0"

# -- Resource limits and requests for the UWS database pod
# @default -- See `values.yaml`
Expand Down
Loading