Skip to content
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.

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

Fix fileingestion documentation #185

Merged
merged 2 commits into from
Jan 30, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
15 changes: 3 additions & 12 deletions getting-started/templates/systemlink-secrets.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ dashboardhost:
## Password for database access.
##
password: "" # <ATTENTION>
## Admin credentials for the Grafana instance.
## Admin credentials for the Grafana instance.
## Note: You cannot change the credentials after the first deployment.
grafana:
## Admin user name. The default can be used.
Expand Down Expand Up @@ -299,15 +299,6 @@ fileingestion:
## Refer to the MongoDB documentation for key generation: https://www.mongodb.com/docs/manual/tutorial/enforce-keyfile-access-control-in-existing-replica-set/#create-a-keyfile
##
replicaSetKey: "" # <ATTENTION>
## Default values for the token used in downloading a file
##
downloadToken:
## Availability of the token
##
expirySeconds: 60
## The secret used to create the encrypted token
##
encryptionKeySecret: "fileingestionservices-download-encryption-key"

## Secret configuration for Jupyter notebook execution.
##
Expand Down Expand Up @@ -384,7 +375,7 @@ sysmgmtevent:
saltmaster:
secrets:
## Credentials for the MongoDB cluster.
##
##
mongodb:
# Root user password for the database cluster.
rootPassword: ""
Expand All @@ -396,7 +387,7 @@ saltmaster:
# Refer to MongoDB documentation for key generation: https://www.mongodb.com/docs/manual/tutorial/enforce-keyfile-access-control-in-existing-replica-set/#create-a-keyfile
replicaSetKey: ""
## RSA keys used by saltmaster in the communication with client systems.
##
##
saltmaster:
# RSA Private key using PKCS1 padding for salt-master.
privateKey:
Expand Down
47 changes: 39 additions & 8 deletions getting-started/templates/systemlink-values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -86,14 +86,14 @@ global:
cdnEndpoint: "https://web-sdk.ni.com/"
##
## MongoDB Database Configuration.
## Many Systemlink Enterprise services utilize MongoDB databases for data storage. Customers can deploy their own MongoDB instance
## Many Systemlink Enterprise services utilize MongoDB databases for data storage. Customers can deploy their own MongoDB instance
## or utilize a managed solution such as MongoDB Atlas. Once provisioned provide the connection details in global.secrets.mongodb.connection_string.
##
mongodb:
## Enable or disable installation of per-service MongoDB instances.
## Enable or disable installation of per-service MongoDB instances.
# <ATTENTION> - If you do *not* have your own MongoDB instance set this (`global.mongodb.install`) to `true`.
##
install: false
install: false

## Core configuration for the RabbitMQ message broker
##
Expand Down Expand Up @@ -472,7 +472,7 @@ dashboardhost:
## <ATTENTION> - You must create the database manually before deploying. If you are using the default database
## name, you must create a database named "grafana". The database user, if not a superuser, will require USAGE
## and CREATE privileges on the "public" schema and SELECT, INSERT, UPDATE, and DELETE privileges on all tables
## in the "public" schema.
## in the "public" schema.
# name: "database-name"
## Use either URL or the other fields above to configure the database.
## url: postgres://dashboardhost:[email protected]:5432/grafana
Expand Down Expand Up @@ -732,13 +732,44 @@ fileingestion:
## Configure rate limiting. Limits are enforced per-user. Each replica of the file ingestion service
## applies its own per-user limit. With load-balancing, the effective rate will be higher than the
## individual rates configured here.
## Configure rate limits.
##
rateLimits:
## Upload file
##
upload: 3
## Download file
##
download: 3
## Delete file
##
delete: 5
## Delete many files
##
deleteMany: 5
## Query files
##
query: 5
## Get download tokens for downloading file
##
getDownloadToken: 5
## Update file
##
update: 5
## List files
##
list: 5
# Configure the maximum accepted size of uploaded files, expressed in gigabytes.
uploadLimitGB: 10
## Default values for the token used in downloading a file
##
downloadToken:
## Availability of the token expressed in seconds
##
expirySeconds: 60
## The secret used to create the encrypted token used for download files
##
encryptionKeySecret: "fileingestionservices-download-encryption-key"

## Configuration for JupyterHub.
##
Expand All @@ -754,12 +785,12 @@ sl-jupyterhub:
egressAllowRules:
# <ATTENTION> - Set to true to enable JupyterHub user pods to establish outbound connections to private IP addresses.
privateIPs: false
# JupyterHub storage configuration.
# JupyterHub storage configuration.
storage:
## PVC Storage Request for every JupyterHub userpod.
# <ATTENTION> - Adjust this size to match the needs of your application.
capacity: 1Gi

## Ingress configuration.
##
ingress:
Expand Down Expand Up @@ -828,7 +859,7 @@ nbexecservice:
secretKeySecret:
name: "notebookexecution-s3-credentials"
key: "password"

## Configuration for event-based routine triggering.
##
routineeventtrigger:
Expand Down Expand Up @@ -906,7 +937,7 @@ comments:
## Configuration for work order service.
##
workorder:
## Set to true to enable the deployment of the work order and lab management UI service. By default,
## Set to true to enable the deployment of the work order and lab management UI service. By default,
## this is disabled and the work order and lab management UI service are not deployed.
## <ATTENTION> - Set to true to use the work order APIs and lab management UI.
##
Expand Down
Loading