From f13d559eb5de7cd6225139bef567a17b715bec02 Mon Sep 17 00:00:00 2001 From: Willy Kloucek <34452982+wkloucek@users.noreply.github.com> Date: Wed, 29 Jun 2022 07:40:22 +0200 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Martin Co-authored-by: Phil Davis --- docs/services/proxy/_index.md | 2 +- docs/services/thumbnails/_index.md | 2 +- docs/services/web/_index.md | 2 +- services/gateway/pkg/config/config.go | 2 +- services/ocdav/pkg/config/config.go | 2 +- services/sharing/pkg/config/config.go | 2 +- services/storage-system/pkg/config/config.go | 2 +- services/storage-users/pkg/config/config.go | 4 ++-- services/web/pkg/config/http.go | 2 +- 9 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/services/proxy/_index.md b/docs/services/proxy/_index.md index 8c0dbcb62..e4fbce6b9 100644 --- a/docs/services/proxy/_index.md +++ b/docs/services/proxy/_index.md @@ -9,7 +9,7 @@ geekdocCollapseSection: true ## Abstract -This service provides a proxy service that routes requests to the correct extensions. +The proxy service acts as an API Gateway and routes requests to the correct target service. It also provides standard proxy services. ## Table of Contents diff --git a/docs/services/thumbnails/_index.md b/docs/services/thumbnails/_index.md index 86c71e11c..52935717e 100644 --- a/docs/services/thumbnails/_index.md +++ b/docs/services/thumbnails/_index.md @@ -10,7 +10,7 @@ geekdocCollapseSection: true ## Abstract -This service provides an ocis extensions which generates thumbnails for image files. +The thumbnail service generates thumbnails for image files. ## Table of Contents diff --git a/docs/services/web/_index.md b/docs/services/web/_index.md index c5571c001..3f2625c4e 100644 --- a/docs/services/web/_index.md +++ b/docs/services/web/_index.md @@ -10,7 +10,7 @@ geekdocCollapseSection: true ## Abstract -This service embeds [ownCloud Web](https://github.com/owncloud/web) to provide a UI for ownCloud Infinite Scale. +The web service embeds [ownCloud Web](https://github.com/owncloud/web) to provide a UI for ownCloud Infinite Scale. ## Table of Contents diff --git a/services/gateway/pkg/config/config.go b/services/gateway/pkg/config/config.go index 355b6decd..4cd0a9a50 100644 --- a/services/gateway/pkg/config/config.go +++ b/services/gateway/pkg/config/config.go @@ -27,7 +27,7 @@ type Config struct { DisableHomeCreationOnLogin bool `yaml:"disable_home_creation_on_login" env:"GATEWAY_DISABLE_HOME_CREATION_ON_LOGIN" desc:"Disable creation of the home space on login."` TransferSecret string `yaml:"transfer_secret" env:"STORAGE_TRANSFER_SECRET" desc:"The storage transfer secret"` // TODO: how to name the env TransferExpires int `yaml:"transfer_expires" env:"GATEWAY_TRANSFER_EXPIRES" desc:"Expiry for the gateway tokens"` - EtagCacheTTL int `yaml:"etag_cache_ttl" env:"GATEWAY_ETAG_CACHE_TTL" desc:"Max TTL for the gateway's ETAG cache."` + EtagCacheTTL int `yaml:"etag_cache_ttl" env:"GATEWAY_ETAG_CACHE_TTL" desc:"Max TTL in seconds for the gateway's ETAG cache."` FrontendPublicURL string `yaml:"frontend_public_url" env:"OCIS_URL;GATEWAY_FRONTEND_PUBLIC_URL" desc:"The public facing url of the ocis frontend."` diff --git a/services/ocdav/pkg/config/config.go b/services/ocdav/pkg/config/config.go index 04fb48ebe..cbd33b6ff 100644 --- a/services/ocdav/pkg/config/config.go +++ b/services/ocdav/pkg/config/config.go @@ -29,7 +29,7 @@ type Config struct { // Insecure certificates allowed when making requests to the gateway Insecure bool `yaml:"insecure" env:"OCIS_INSECURE;OCDAV_INSECURE"` // Timeout in seconds when making requests to the gateway - Timeout int64 `yaml:"gateway_request_timeout" env:"OCDAV_GATEWAY_REQUEST_TIMEOUT" desc:"Request timeout for requests from the oCDAV service to the gateway service."` + Timeout int64 `yaml:"gateway_request_timeout" env:"OCDAV_GATEWAY_REQUEST_TIMEOUT" desc:"Request timeout in seconds for requests from the oCDAV service to the gateway service."` Middleware Middleware `yaml:"middleware"` Context context.Context `yaml:"-"` diff --git a/services/sharing/pkg/config/config.go b/services/sharing/pkg/config/config.go index 6685555ad..dcb801239 100644 --- a/services/sharing/pkg/config/config.go +++ b/services/sharing/pkg/config/config.go @@ -88,7 +88,7 @@ type UserSharingOwnCloudSQLDriver struct { DBUsername string `yaml:"db_username" env:"SHARING_USER_OWNCLOUDSQL_DB_USERNAME" desc:"Username for the database."` DBPassword string `yaml:"db_password" env:"SHARING_USER_OWNCLOUDSQL_DB_PASSWORD" desc:"Password for the database."` DBHost string `yaml:"db_host" env:"SHARING_USER_OWNCLOUDSQL_DB_HOST" desc:"Hostname or IP of the database server."` - DBPort int `yaml:"db_port" env:"SHARING_USER_OWNCLOUDSQL_DB_PORT" desc:"Port, the database server is listening on."` + DBPort int `yaml:"db_port" env:"SHARING_USER_OWNCLOUDSQL_DB_PORT" desc:"Port that the database server is listening on."` DBName string `yaml:"db_name" env:"SHARING_USER_OWNCLOUDSQL_DB_NAME" desc:"Name of the database to be used."` UserStorageMountID string `yaml:"user_storage_mount_id" env:"SHARING_USER_OWNCLOUDSQL_USER_STORAGE_MOUNT_ID" desc:"Mount ID of the ownCloudSQL users storage for mapping ownCloud 10 shares."` } diff --git a/services/storage-system/pkg/config/config.go b/services/storage-system/pkg/config/config.go index a0d17e906..77804959e 100644 --- a/services/storage-system/pkg/config/config.go +++ b/services/storage-system/pkg/config/config.go @@ -26,7 +26,7 @@ type Config struct { Driver string `yaml:"driver" env:"STORAGE_SYSTEM_DRIVER" desc:"The driver which should be used by the service"` Drivers Drivers `yaml:"drivers"` - DataServerURL string `yaml:"data_server_url" env:"STORAGE_SYSTEM_DATA_SERVER_URL" desc:"URL of the data server, needs to be reachable by services using the this service."` + DataServerURL string `yaml:"data_server_url" env:"STORAGE_SYSTEM_DATA_SERVER_URL" desc:"URL of the data server, needs to be reachable by services using this service."` Supervised bool `yaml:"-"` Context context.Context `yaml:"-"` diff --git a/services/storage-users/pkg/config/config.go b/services/storage-users/pkg/config/config.go index e6547df35..d29a1b96c 100644 --- a/services/storage-users/pkg/config/config.go +++ b/services/storage-users/pkg/config/config.go @@ -23,7 +23,7 @@ type Config struct { Driver string `yaml:"driver" env:"STORAGE_USERS_DRIVER" desc:"The storage driver which should be used by the service"` Drivers Drivers `yaml:"drivers"` - DataServerURL string `yaml:"data_server_url" env:"STORAGE_USERS_DATA_SERVER_URL" desc:"URL of the data server, needs to be reachable by the data gateway provided by the frontend service or the user if directly expose."` + DataServerURL string `yaml:"data_server_url" env:"STORAGE_USERS_DATA_SERVER_URL" desc:"URL of the data server, needs to be reachable by the data gateway provided by the frontend service or the user if directly exposed."` Events Events `yaml:"events"` MountID string `yaml:"mount_id" env:"STORAGE_USERS_MOUNT_ID" desc:"Mount ID of this storage."` ExposeDataServer bool `yaml:"expose_data_server" env:"STORAGE_USERS_EXPOSE_DATA_SERVER" desc:"Exposes the data server directly to users and bypasses the data gateway. Ensure that the data server address is reachable by users."` @@ -125,7 +125,7 @@ type OwnCloudSQLDriver struct { DBUsername string `yaml:"db_username" env:"STORAGE_USERS_OWNCLOUDSQL_DB_USERNAME" desc:"Username for the database."` DBPassword string `yaml:"db_password" env:"STORAGE_USERS_OWNCLOUDSQL_DB_PASSWORD" desc:"Password for the database."` DBHost string `yaml:"db_host" env:"STORAGE_USERS_OWNCLOUDSQL_DB_HOST" desc:"Hostname or IP of the database server."` - DBPort int `yaml:"db_port" env:"STORAGE_USERS_OWNCLOUDSQL_DB_PORT" desc:"Port, the database server is listening on."` + DBPort int `yaml:"db_port" env:"STORAGE_USERS_OWNCLOUDSQL_DB_PORT" desc:"Port that the database server is listening on."` DBName string `yaml:"db_name" env:"STORAGE_USERS_OWNCLOUDSQL_DB_NAME" desc:"Name of the database to be used."` UsersProviderEndpoint string `yaml:"users_provider_endpoint" env:"STORAGE_USERS_OWNCLOUDSQL_USERS_PROVIDER_ENDPOINT" desc:"Endpoint of the users provider."` } diff --git a/services/web/pkg/config/http.go b/services/web/pkg/config/http.go index 0e2835ec2..a328c1de5 100644 --- a/services/web/pkg/config/http.go +++ b/services/web/pkg/config/http.go @@ -5,5 +5,5 @@ type HTTP struct { Addr string `yaml:"addr" env:"WEB_HTTP_ADDR" desc:"The bind address of the HTTP service."` Namespace string `yaml:"-"` Root string `yaml:"root" env:"WEB_HTTP_ROOT" desc:"The root path of the HTTP service."` - CacheTTL int `yaml:"cache_ttl" env:"WEB_CACHE_TTL" desc:"Cache policy for ownCloud Web assets."` + CacheTTL int `yaml:"cache_ttl" env:"WEB_CACHE_TTL" desc:"Cache policy in seconds for ownCloud Web assets."` }