misc: update the descriptions of env variables

api/bean/AutocompleteConfig.go

@@ -17,5 +17,5 @@
 package bean
 
 type Config struct {
-	IgnoreAuthCheck bool `env:"IGNORE_AUTOCOMPLETE_AUTH_CHECK" envDefault:"false"`
+	IgnoreAuthCheck bool `env:"IGNORE_AUTOCOMPLETE_AUTH_CHECK" envDefault:"false" description:"flag for ignoring auth check in autocomplete apis."`
 }

api/helm-app/gRPC/applicationClient.go

@@ -75,7 +75,7 @@ func NewHelmAppClientImpl(logger *zap.SugaredLogger,
 
 // CATEGORY=INFRA_SETUP
 type HelmClientConfig struct {
-	Url string `env:"HELM_CLIENT_URL" envDefault:"127.0.0.1:50051"`
+	Url string `env:"HELM_CLIENT_URL" envDefault:"127.0.0.1:50051" description:"Kubelink micro-service url "`
 }
 
 func GetConfig() (*HelmClientConfig, error) {

api/helm-app/service/HelmAppService.go

@@ -159,9 +159,9 @@ func NewHelmAppServiceImpl(Logger *zap.SugaredLogger, clusterService cluster.Clu
 
 // CATEGORY=CD
 type HelmReleaseConfig struct {
-	RevisionHistoryLimitDevtronApp      int `env:"REVISION_HISTORY_LIMIT_DEVTRON_APP" envDefault:"1"`
-	RevisionHistoryLimitHelmApp         int `env:"REVISION_HISTORY_LIMIT_HELM_APP" envDefault:"1"`
-	RevisionHistoryLimitExternalHelmApp int `env:"REVISION_HISTORY_LIMIT_EXTERNAL_HELM_APP" envDefault:"0"`
+	RevisionHistoryLimitDevtronApp      int `env:"REVISION_HISTORY_LIMIT_DEVTRON_APP" envDefault:"1" description:"Count for devtron application rivision history"`
+	RevisionHistoryLimitHelmApp         int `env:"REVISION_HISTORY_LIMIT_HELM_APP" envDefault:"1" description:"To set the history limit for the helm app being deployed through devtron"`
+	RevisionHistoryLimitExternalHelmApp int `env:"REVISION_HISTORY_LIMIT_EXTERNAL_HELM_APP" envDefault:"0" description:"Count for external helm application rivision history"`
 	RevisionHistoryLimitLinkedHelmApp   int `env:"REVISION_HISTORY_LIMIT_LINKED_HELM_APP" envDefault:"15"`
 }
 

api/restHandler/app/pipeline/configure/PipelineConfigRestHandler.go

@@ -69,7 +69,7 @@ import (
 )
 
 type PipelineRestHandlerEnvConfig struct {
-	UseArtifactListApiV2 bool `env:"USE_ARTIFACT_LISTING_API_V2" envDefault:"true"` //deprecated
+	UseArtifactListApiV2 bool `env:"USE_ARTIFACT_LISTING_API_V2" envDefault:"true" description:"To use the V2 API for listing artifacts in Listing the images in pipeline"` //deprecated
 }
 
 type DevtronAppRestHandler interface {

client/argocdServer/ArgoClientWrapperService.go

@@ -51,9 +51,9 @@ import (
 )
 
 type ACDConfig struct {
-	ArgoCDAutoSyncEnabled     bool `env:"ARGO_AUTO_SYNC_ENABLED" envDefault:"true"` // will gradually switch this flag to false in enterprise
-	RegisterRepoMaxRetryCount int  `env:"ARGO_REPO_REGISTER_RETRY_COUNT" envDefault:"3"`
-	RegisterRepoMaxRetryDelay int  `env:"ARGO_REPO_REGISTER_RETRY_DELAY" envDefault:"10"`
+	ArgoCDAutoSyncEnabled     bool `env:"ARGO_AUTO_SYNC_ENABLED" envDefault:"true" description:"If enabled all argocd application will have auto sync enabled"` // will gradually switch this flag to false in enterprise
+	RegisterRepoMaxRetryCount int  `env:"ARGO_REPO_REGISTER_RETRY_COUNT" envDefault:"3" description:"Argo app registration in argo retries on deployment"`
+	RegisterRepoMaxRetryDelay int  `env:"ARGO_REPO_REGISTER_RETRY_DELAY" envDefault:"10" description:"Argo app registration in argo cd on deployment delay between retry"`
 }
 
 func (config *ACDConfig) IsManualSyncEnabled() bool {

client/argocdServer/bean/connection.go

@@ -25,8 +25,8 @@ type AcdAuthConfig struct {
 }
 
 type Config struct {
-	Host      string `env:"CD_HOST" envDefault:"localhost"`
-	Port      string `env:"CD_PORT" envDefault:"8000"`
+	Host      string `env:"CD_HOST" envDefault:"localhost" description:"Host for the devtron stack"`
+	Port      string `env:"CD_PORT" envDefault:"8000" description:"Port for pre/post-cd" `
 	Namespace string `env:"CD_NAMESPACE" envDefault:"devtroncd"`
 }
 

client/cron/CiStatusUpdateCron.go

@@ -66,8 +66,8 @@ func NewCiStatusUpdateCronImpl(logger *zap.SugaredLogger, appService app.AppServ
 }
 
 type CiWorkflowStatusUpdateConfig struct {
-	CiWorkflowStatusUpdateCron string `env:"CI_WORKFLOW_STATUS_UPDATE_CRON" envDefault:"*/5 * * * *"`
-	TimeoutForFailedCiBuild    string `env:"TIMEOUT_FOR_FAILED_CI_BUILD" envDefault:"15"` //in minutes
+	CiWorkflowStatusUpdateCron string `env:"CI_WORKFLOW_STATUS_UPDATE_CRON" envDefault:"*/5 * * * *" description:"Cron schedule for CI pipeline status"`
+	TimeoutForFailedCiBuild    string `env:"TIMEOUT_FOR_FAILED_CI_BUILD" envDefault:"15" description:"Timeout for Failed CI build "` //in minutes
 }
 
 func GetCiWorkflowStatusUpdateConfig() (*CiWorkflowStatusUpdateConfig, error) {

client/cron/CiTriggerCron.go

@@ -69,8 +69,8 @@ func NewCiTriggerCronImpl(logger *zap.SugaredLogger, cfg *CiTriggerCronConfig, p
 }
 
 type CiTriggerCronConfig struct {
-	SourceControllerCronTime int    `env:"CI_TRIGGER_CRON_TIME" envDefault:"2"`
-	PluginName               string `env:"PLUGIN_NAME"  envDefault:"Pull images from container repository"`
+	SourceControllerCronTime int    `env:"CI_TRIGGER_CRON_TIME" envDefault:"2" description:"For image poll plugin"`
+	PluginName               string `env:"PLUGIN_NAME"  envDefault:"Pull images from container repository" description:"Handles image retrieval from a container repository and triggers subsequent CI processes upon detecting new images.Current default plugin name: Pull Images from Container Repository."`
 }
 
 func GetCiTriggerCronConfig() (*CiTriggerCronConfig, error) {

client/dashboard/Config.go

@@ -22,9 +22,9 @@ import (
 
 // CATEGORY=INFRA_SETUP
 type Config struct {
-	Host      string `env:"DASHBOARD_HOST" envDefault:"localhost"`
-	Port      string `env:"DASHBOARD_PORT" envDefault:"3000"`
-	Namespace string `env:"DASHBOARD_NAMESPACE" envDefault:"devtroncd"`
+	Host      string `env:"DASHBOARD_HOST" envDefault:"localhost" description:"Dashboard micro-service URL"`
+	Port      string `env:"DASHBOARD_PORT" envDefault:"3000" description:"Port for dashboard micro-service"`
+	Namespace string `env:"DASHBOARD_NAMESPACE" envDefault:"devtroncd" description:"Dashboard micro-service namespace"`
 }
 
 func GetConfig() (*Config, error) {

client/events/EventClient.go

@@ -38,8 +38,8 @@ import (
 )
 
 type EventClientConfig struct {
-	DestinationURL     string             `env:"EVENT_URL" envDefault:"http://localhost:3000/notify"`
-	NotificationMedium NotificationMedium `env:"NOTIFICATION_MEDIUM" envDefault:"rest"`
+	DestinationURL     string             `env:"EVENT_URL" envDefault:"http://localhost:3000/notify" description:"Notifier service url"`
+	NotificationMedium NotificationMedium `env:"NOTIFICATION_MEDIUM" envDefault:"rest" description:"notification medium"`
 }
 type NotificationMedium string
 

client/gitSensor/GitSensorClient.go

@@ -81,9 +81,9 @@ func NewGitSensorClient(logger *zap.SugaredLogger, config *ClientConfig) (*Clien
 
 // CATEGORY=INFRA_SETUP
 type ClientConfig struct {
-	Url      string `env:"GIT_SENSOR_URL" envDefault:"127.0.0.1:7070"`
-	Protocol string `env:"GIT_SENSOR_PROTOCOL" envDefault:"REST"`
-	Timeout  int    `env:"GIT_SENSOR_TIMEOUT" envDefault:"0"` // in seconds
+	Url      string `env:"GIT_SENSOR_URL" envDefault:"127.0.0.1:7070" description:"git-sensor micro-service url "`
+	Protocol string `env:"GIT_SENSOR_PROTOCOL" envDefault:"REST" description:"Protocol to connect with git-sensor micro-service"`
+	Timeout  int    `env:"GIT_SENSOR_TIMEOUT" envDefault:"0" description:"Timeout for getting response from the git-sensor"` // in seconds
 }
 
 func GetConfig() (*ClientConfig, error) {

client/grafana/Config.go

@@ -19,9 +19,9 @@ package grafana
 import "github.com/caarlos0/env"
 
 type Config struct {
-	Host      string `env:"GRAFANA_HOST" envDefault:"localhost"`
-	Port      string `env:"GRAFANA_PORT" envDefault:"8090"`
-	Namespace string `env:"GRAFANA_NAMESPACE" envDefault:"devtroncd"`
+	Host      string `env:"GRAFANA_HOST" envDefault:"localhost" description:"Host URL for the grafana dashboard"`
+	Port      string `env:"GRAFANA_PORT" envDefault:"8090" description:"Port for grafana micro-service"`
+	Namespace string `env:"GRAFANA_NAMESPACE" envDefault:"devtroncd" description:"Namespace for grafana"`
 }
 
 func GetConfig() (*Config, error) {

client/grafana/GrafanaClient.go

@@ -34,10 +34,10 @@ import (
 )
 
 type GrafanaClientConfig struct {
-	GrafanaUsername string `env:"GRAFANA_USERNAME" envDefault:"admin"`
-	GrafanaPassword string `env:"GRAFANA_PASSWORD" envDefault:"prom-operator"`
-	GrafanaOrgId    int    `env:"GRAFANA_ORG_ID" envDefault:"2"`
-	DestinationURL  string `env:"GRAFANA_URL" envDefault:""`
+	GrafanaUsername string `env:"GRAFANA_USERNAME" envDefault:"admin" description:"Username for grafana "`
+	GrafanaPassword string `env:"GRAFANA_PASSWORD" envDefault:"prom-operator" description:"Password for grafana dashboard"`
+	GrafanaOrgId    int    `env:"GRAFANA_ORG_ID" envDefault:"2" description:"Org ID for grafana for application metrics"`
+	DestinationURL  string `env:"GRAFANA_URL" envDefault:"" description:"Host URL for the grafana dashboard"`
 }
 
 const PromDatasource = "/api/datasources"

client/lens/LensClient.go

@@ -30,8 +30,8 @@ import (
 )
 
 type LensConfig struct {
-	Url     string `env:"LENS_URL" envDefault:"http://lens-milandevtron-service:80"`
-	Timeout int    `env:"LENS_TIMEOUT" envDefault:"0"` // in seconds
+	Url     string `env:"LENS_URL" envDefault:"http://lens-milandevtron-service:80" description:"Lens micro-service URL"`
+	Timeout int    `env:"LENS_TIMEOUT" envDefault:"0" description:"Lens microservice timeout."` // in seconds
 }
 type StatusCode int
 

client/proxy/ProxyRouter.go

@@ -38,7 +38,7 @@ type ProxyConnection struct {
 }
 
 type Config struct {
-	ProxyServiceConfig string `env:"PROXY_SERVICE_CONFIG" envDefault:"{}"`
+	ProxyServiceConfig string `env:"PROXY_SERVICE_CONFIG" envDefault:"{}" description:"Proxy configuration for micro-service to be accessible on orhcestrator ingress"`
 }
 
 func GetProxyConfig() (*Config, error) {