chore: adjust env vars so that check-env-var-annotations passes

.make/check-env-var-annotations.sh

@@ -1,7 +1,7 @@
 #!/bin/bash
 
 # The following grep will filter out every line containing an `env` annotation
-# it will ignore every line that has allready a valid `introductionVersion` annotation
+# it will ignore every line that already has a valid `introductionVersion` annotation
 #
 # valid examples:
 #
@@ -24,28 +24,31 @@ ERROR=0
 
 SEMVER_REGEX="([0-9]|[1-9][0-9]*)(\.([0-9]|[1-9][0-9]*)){1,2}(?:-([0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*))?(?:\+[0-9A-Za-z-]+)?"
 
-QUERY_INTRO=$(git grep "env:" -- '*.go' |grep -v -P "introductionVersion:\"($SEMVER_REGEX|(pre5\.0))\""|grep -v "_test.go"|grep -v "vendor/")
-
+QUERY_INTRO=$(git grep -n "env:" -- '*.go' |grep -v -P "introductionVersion:\"($SEMVER_REGEX|(pre5\.0))\""|grep -v "_test.go"|grep -v "vendor/")
 RESULTS_INTRO=$(echo "${QUERY_INTRO}"|wc -l)
-if [ "${RESULTS_INTRO}" -gt 0 ]; then
+if [ "${QUERY_INTRO}" != "" ] && [ "${RESULTS_INTRO}" -gt 0 ]; then
   echo "==============================================================================================="
-  echo "The following ${RESULTS_INTRO} files contain an invalid introductionVersion annotation:"
+  echo "The following ${RESULTS_INTRO} items contain an invalid or missing introductionVersion annotation:"
   echo "==============================================================================================="
   echo "$QUERY_INTRO"
   ERROR=1
+else
+  echo "All introductionVersion annotations are valid"
 fi
 
 # The following grep will filter out every line containing an `env` annotation
 # it will ignore every line that has allready a valid `desc` annotation
 
-QUERY_DESC=$(git grep "env:" -- '*.go' |grep -v -P "desc:\".{10,}\""|grep -v "_test.go"|grep -v "vendor/")
+QUERY_DESC=$(git grep -n "env:" -- '*.go' |grep -v -P "desc:\".{10,}\""|grep -v "_test.go"|grep -v "vendor/")
 
 RESULTS_DESC=$(echo "${QUERY_DESC}"|wc -l)
-if [ "${RESULTS_DESC}" -gt 0 ]; then
+if [ "${QUERY_DESC}" != "" ] && [ "${RESULTS_DESC}" -gt 0 ]; then
   echo "==============================================================================================="
-  echo "The following ${RESULTS_DESC} files contain an invalid description annotation:"
+  echo "The following ${RESULTS_DESC} items contain an invalid or missing description annotation:"
   echo "==============================================================================================="
   echo "$QUERY_DESC"
   ERROR=1
+else
+  echo "All description annotations are valid"
 fi
 exit ${ERROR}

changelog/5.0.0-rc.5_2024-02-26/env-var-annotations.md

@@ -1,6 +1,6 @@
 Enhancement: Add a make step to validate the env var annotations
 
-We have added a make step `make validate-env-var-annotations` to validate the env var annotations in to the environment variables.
+We have added a make step `make check-env-var-annotations` to validate the environment variable annotations in to the environment variables.
 
 https://github.com/owncloud/ocis/pull/8436
 https://github.com/owncloud/ocis/issues/8258

ocis-pkg/config/config.go

@@ -48,11 +48,11 @@ type Mode int
 
 // Runtime configures the oCIS runtime when running in supervised mode.
 type Runtime struct {
-	Port       string   `yaml:"port" env:"OCIS_RUNTIME_PORT"`
-	Host       string   `yaml:"host" env:"OCIS_RUNTIME_HOST"`
-	Services   []string `yaml:"services" env:"OCIS_RUN_EXTENSIONS;OCIS_RUN_SERVICES" desc:"A comma-separated list of service names. Will start only the listed services."`
-	Disabled   []string `yaml:"disabled_services" env:"OCIS_EXCLUDE_RUN_SERVICES" desc:"A comma-separated list of service names. Will start all default services except of the ones listed. Has no effect when OCIS_RUN_SERVICES is set."`
-	Additional []string `yaml:"add_services" env:"OCIS_ADD_RUN_SERVICES" desc:"A comma-separated list of service names. Will add the listed services to the default configuration. Has no effect when OCIS_RUN_SERVICES is set. Note that one can add services not started by the default list and exclude services from the default list by using both envvars at the same time."`
+	Port       string   `yaml:"port" env:"OCIS_RUNTIME_PORT" desc:"The TCP port at which oCIS will be available" introductionVersion:"pre5.0"`
+	Host       string   `yaml:"host" env:"OCIS_RUNTIME_HOST" desc:"The host at which oCIS will be available" introductionVersion:"pre5.0"`
+	Services   []string `yaml:"services" env:"OCIS_RUN_EXTENSIONS;OCIS_RUN_SERVICES" desc:"A comma-separated list of service names. Will start only the listed services." introductionVersion:"pre5.0"`
+	Disabled   []string `yaml:"disabled_services" env:"OCIS_EXCLUDE_RUN_SERVICES" desc:"A comma-separated list of service names. Will start all default services except of the ones listed. Has no effect when OCIS_RUN_SERVICES is set." introductionVersion:"pre5.0"`
+	Additional []string `yaml:"add_services" env:"OCIS_ADD_RUN_SERVICES" desc:"A comma-separated list of service names. Will add the listed services to the default configuration. Has no effect when OCIS_RUN_SERVICES is set. Note that one can add services not started by the default list and exclude services from the default list by using both envvars at the same time." introductionVersion:"pre5.0"`
 }
 
 // Config combines all available configuration parts.
@@ -72,11 +72,11 @@ type Config struct {
 
 	Registry          string               `yaml:"registry"`
 	TokenManager      *shared.TokenManager `yaml:"token_manager"`
-	MachineAuthAPIKey string               `yaml:"machine_auth_api_key" env:"OCIS_MACHINE_AUTH_API_KEY" desc:"Machine auth API key used to validate internal requests necessary for the access to resources from other services."`
-	TransferSecret    string               `yaml:"transfer_secret" env:"OCIS_TRANSFER_SECRET" desc:"Transfer secret for signing file up- and download requests."`
-	SystemUserID      string               `yaml:"system_user_id" env:"OCIS_SYSTEM_USER_ID" desc:"ID of the oCIS storage-system system user. Admins need to set the ID for the storage-system system user in this config option which is then used to reference the user. Any reasonable long string is possible, preferably this would be an UUIDv4 format."`
-	SystemUserAPIKey  string               `yaml:"system_user_api_key" env:"OCIS_SYSTEM_USER_API_KEY" desc:"API key for the storage-system system user."`
-	AdminUserID       string               `yaml:"admin_user_id" env:"OCIS_ADMIN_USER_ID" desc:"ID of a user, that should receive admin privileges. Consider that the UUID can be encoded in some LDAP deployment configurations like in .ldif files. These need to be decoded beforehand."`
+	MachineAuthAPIKey string               `yaml:"machine_auth_api_key" env:"OCIS_MACHINE_AUTH_API_KEY" desc:"Machine auth API key used to validate internal requests necessary for the access to resources from other services." introductionVersion:"5.0"`
+	TransferSecret    string               `yaml:"transfer_secret" env:"OCIS_TRANSFER_SECRET" desc:"Transfer secret for signing file up- and download requests." introductionVersion:"pre5.0"`
+	SystemUserID      string               `yaml:"system_user_id" env:"OCIS_SYSTEM_USER_ID" desc:"ID of the oCIS storage-system system user. Admins need to set the ID for the storage-system system user in this config option which is then used to reference the user. Any reasonable long string is possible, preferably this would be an UUIDv4 format." introductionVersion:"pre5.0"`
+	SystemUserAPIKey  string               `yaml:"system_user_api_key" env:"OCIS_SYSTEM_USER_API_KEY" desc:"API key for the storage-system system user." introductionVersion:"pre5.0"`
+	AdminUserID       string               `yaml:"admin_user_id" env:"OCIS_ADMIN_USER_ID" desc:"ID of a user, that should receive admin privileges. Consider that the UUID can be encoded in some LDAP deployment configurations like in .ldif files. These need to be decoded beforehand." introductionVersion:"pre5.0"`
 	Runtime           Runtime              `yaml:"runtime"`
 
 	Antivirus         *antivirus.Config      `yaml:"antivirus"`