Skip to content

Commit

Permalink
expose more log options and default to stdout log
Browse files Browse the repository at this point in the history
  • Loading branch information
@wkloucek @SamuAlfageme
wkloucek authored and SamuAlfageme committed Feb 7, 2023
1 parent e6aa011 commit dfb4d18
Show file tree
Hide file tree
Showing 4 changed files with 54 additions and 34 deletions.
5 changes: 3 additions & 2 deletions wopiserver/Chart.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ apiVersion: v2
name: wopiserver
description: A Vendor-neutral Web-application Open Platform Interface (WOPI) gateway for EFSS systems
type: application
version: 0.6.0
version: 0.7.0
appVersion: v9.4.0
kubeVersion: '>= 1.19.0'
home: https://github.com/cs3org/wopiserver
Expand All @@ -18,7 +18,8 @@ keywords:
- efss
annotations:
artifacthub.io/changes: |
- "Update wopiserver to v9.4.0"
- "Add more log related settings"
- "Log to stdout by default"
artifacthub.io/images: |
- name: wopiserver
image: cs3org/wopiserver:v9.4.0
Expand Down
62 changes: 32 additions & 30 deletions wopiserver/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,33 +26,35 @@ helm delete my-wopi

The following configurations may be set. It is recommended to use `values.yaml` for overwriting the wopiserver config.

| Parameter | Description | Default |
| ------------------------------ | ---------------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
| `config.cs3.authTokenValidity` | Reva/gRPC authentication token expiration time (seconds). | `3600` |
| `config.cs3.gateway` | The GRPC endpoint of the REVA gateway service. | `revad:19000` |
| `config.cs3.sslVerify` | Enables certificate checking for downloads from the REVA datagateway. | `True` |
| `config.bridge.sslVerify` | Enables certificate checking for the connected apps. | `True` |
| `config.detectExternalLocks` | Enables detection of external Microsoft Office or LibreOffice locks. | `False` |
| `config.loglevel` | Log level. Values, in order of severity: `Critical`, `Error`, `Warning`, `Info` `Debug`. | `Debug` |
| `config.token.validity` | WOPI access token expiration time (seconds). | `86400` |
| `config.wopi.lock.expiration` | WOPI lock expiration time (seconds). | `3600` |
| `extraResources` | Extra resources to be included. | `[]` |
| `image.pullPolicy` | The kubernetes image pull policy. | `IfNotPresent` |
| `image.repository` | Name of the image to run, without the tag. | [`cs3org/wopiserver`](https://hub.docker.com/r/cs3org/wopiserver) |
| `image.tag` | The image tag to use. | `v9.4.0` |
| `image.pullSecrets` | List of names of secrets containing container image registry access keys. | `[]` |
| `ingress.annotations` | Ingress annotations. | `{}` |
| `ingress.enabled` | Whether to create an Ingress resource to access the wopiserver. | `false` |
| `ingress.hostname` | The ingress hostname. | `wopi.local` |
| `ingress.path` | The ingress path. | `/wopi` |
| `ingress.tls` | Ingress TLS configuration (YAML). | `[]` |
| `replicaCount` | How many replicas to run. | `1` |
| `resources` | Resources to apply to all services. | `{}` |
| `secrets.wopiSecret` | WOPI secret used for signing JWT tokens. | `nil` - generates a random secret (`randAlphaNum 24`) |
| `secretsRef` | Use an already existing secret instead of configuring the `secrets` settings. | `nil` |
| `securityContext.fsGroup` | File system group for all volumes. | `1000` |
| `securityContext.runAsGroup` | Group ID that all processes within any containers will run with. | `1000` |
| `securityContext.runAsUser` | User ID that all processes within any containers will run with. | `1000` |
| `service.port` | The wopiserver service HTTP port. | `8880` |
| `service.type` | The Kubernetes service type to use. | `ClusterIP` |
| `wopiserverUrl` | Overrides the (default) Helm URL generation based on the ingress/service values. | `nil` |
| Parameter | Description | Default |
| ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
| `config.cs3.authTokenValidity` | Reva/gRPC authentication token expiration time (seconds). | `3600` |
| `config.cs3.gateway` | The GRPC endpoint of the REVA gateway service. | `revad:19000` |
| `config.cs3.sslVerify` | Enables certificate checking for downloads from the REVA datagateway. | `True` |
| `config.bridge.sslVerify` | Enables certificate checking for the connected apps. | `True` |
| `config.detectExternalLocks` | Enables detection of external Microsoft Office or LibreOffice locks. | `False` |
| `config.log.level` | Log level. Values, in order of severity: `Critical`, `Error`, `Warning`, `Info` `Debug`. | `Debug` |
| `config.log.handler` | Log handler. Values: `stream` or `file` | `stream` |
| `config.log.destination` | Log destination. Values if `handler` == `stream`: `stdout` or `stderr`. If `handler` == `file`, set to any existing file path in the container. |
| `config.token.validity` | WOPI access token expiration time (seconds). | `86400` |
| `config.wopi.lock.expiration` | WOPI lock expiration time (seconds). | `3600` |
| `extraResources` | Extra resources to be included. | `[]` |
| `image.pullPolicy` | The kubernetes image pull policy. | `IfNotPresent` |
| `image.repository` | Name of the image to run, without the tag. | [`cs3org/wopiserver`](https://hub.docker.com/r/cs3org/wopiserver) |
| `image.tag` | The image tag to use. | `v9.4.0` |
| `image.pullSecrets` | List of names of secrets containing container image registry access keys. | `[]` |
| `ingress.annotations` | Ingress annotations. | `{}` |
| `ingress.enabled` | Whether to create an Ingress resource to access the wopiserver. | `false` |
| `ingress.hostname` | The ingress hostname. | `wopi.local` |
| `ingress.path` | The ingress path. | `/wopi` |
| `ingress.tls` | Ingress TLS configuration (YAML). | `[]` |
| `replicaCount` | How many replicas to run. | `1` |
| `resources` | Resources to apply to all services. | `{}` |
| `secrets.wopiSecret` | WOPI secret used for signing JWT tokens. | `nil` - generates a random secret (`randAlphaNum 24`) |
| `secretsRef` | Use an already existing secret instead of configuring the `secrets` settings. | `nil` |
| `securityContext.fsGroup` | File system group for all volumes. | `1000` |
| `securityContext.runAsGroup` | Group ID that all processes within any containers will run with. | `1000` |
| `securityContext.runAsUser` | User ID that all processes within any containers will run with. | `1000` |
| `service.port` | The wopiserver service HTTP port. | `8880` |
| `service.type` | The Kubernetes service type to use. | `ClusterIP` |
| `wopiserverUrl` | Overrides the (default) Helm URL generation based on the ingress/service values. | `nil` |
11 changes: 10 additions & 1 deletion wopiserver/templates/configmap.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,16 @@ data:
# Logging level.
# Valid values are: Debug, Info, Warning, Error.
loglevel = {{ .Values.config.logLevel }}
loglevel = {{ .Values.config.log.level }}
# Logging handler. Sets the log handler to use.
# Valid values are: file, stream.
loghandler = {{ .Values.config.log.handler }}
# Logging destination.
# Valid values if 'loghandler = file' are: any existing file path.
# Valid values if 'loghandler = stream' are: stdout, stderr.
logdest = {{ .Values.config.log.destination }}
# URL of your WOPI server or your HA proxy in front of it
wopiurl = {{ template "wopiserver.url" . }}
Expand Down
10 changes: 9 additions & 1 deletion wopiserver/values.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,15 @@ secrets:
wopiSecret:

config:
logLevel: Error
log:
# log level: Debug, Info, Warning or Error
level: Error
# handler for logs: "stream" or "file"
handler: stream
# destination for logs
# if "handler" == "stream": "stdout" or "stderr"
# if "handler" == "file": any existing file path in the container.
destination: stdout
token:
validity: 86400
wopi:
Expand Down

0 comments on commit dfb4d18

Please sign in to comment.