Skip to content

Commit bd387d8

Browse files
neha130neha130
authored
Merge pull request #6499 from devtron-labs/update_config_file
misc: update the descriptions of env variables
2 parents 66f64e5 + 1a4a38b commit bd387d8

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+437
-435
lines changed

‎api/bean/AutocompleteConfig.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,5 @@
1717
package bean
1818

1919
type Config struct {
20-
IgnoreAuthCheck bool `env:"IGNORE_AUTOCOMPLETE_AUTH_CHECK" envDefault:"false"`
20+
IgnoreAuthCheck bool `env:"IGNORE_AUTOCOMPLETE_AUTH_CHECK" envDefault:"false" description:"flag for ignoring auth check in autocomplete apis."`
2121
}

‎api/helm-app/gRPC/applicationClient.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ func NewHelmAppClientImpl(logger *zap.SugaredLogger,
7575

7676
// CATEGORY=INFRA_SETUP
7777
type HelmClientConfig struct {
78-
Url string `env:"HELM_CLIENT_URL" envDefault:"127.0.0.1:50051"`
78+
Url string `env:"HELM_CLIENT_URL" envDefault:"127.0.0.1:50051" description:"Kubelink micro-service url "`
7979
}
8080

8181
func GetConfig() (*HelmClientConfig, error) {

‎api/helm-app/service/HelmAppService.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -159,9 +159,9 @@ func NewHelmAppServiceImpl(Logger *zap.SugaredLogger, clusterService cluster.Clu
159159

160160
// CATEGORY=CD
161161
type HelmReleaseConfig struct {
162-
RevisionHistoryLimitDevtronApp int `env:"REVISION_HISTORY_LIMIT_DEVTRON_APP" envDefault:"1"`
163-
RevisionHistoryLimitHelmApp int `env:"REVISION_HISTORY_LIMIT_HELM_APP" envDefault:"1"`
164-
RevisionHistoryLimitExternalHelmApp int `env:"REVISION_HISTORY_LIMIT_EXTERNAL_HELM_APP" envDefault:"0"`
162+
RevisionHistoryLimitDevtronApp int `env:"REVISION_HISTORY_LIMIT_DEVTRON_APP" envDefault:"1" description:"Count for devtron application rivision history"`
163+
RevisionHistoryLimitHelmApp int `env:"REVISION_HISTORY_LIMIT_HELM_APP" envDefault:"1" description:"To set the history limit for the helm app being deployed through devtron"`
164+
RevisionHistoryLimitExternalHelmApp int `env:"REVISION_HISTORY_LIMIT_EXTERNAL_HELM_APP" envDefault:"0" description:"Count for external helm application rivision history"`
165165
RevisionHistoryLimitLinkedHelmApp int `env:"REVISION_HISTORY_LIMIT_LINKED_HELM_APP" envDefault:"15"`
166166
}
167167

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ import (
6969
)
7070

7171
type PipelineRestHandlerEnvConfig struct {
72-
UseArtifactListApiV2 bool `env:"USE_ARTIFACT_LISTING_API_V2" envDefault:"true"` //deprecated
72+
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
7373
}
7474

7575
type DevtronAppRestHandler interface {

‎client/argocdServer/ArgoClientWrapperService.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,9 @@ import (
5151
)
5252

5353
type ACDConfig struct {
54-
ArgoCDAutoSyncEnabled bool `env:"ARGO_AUTO_SYNC_ENABLED" envDefault:"true"` // will gradually switch this flag to false in enterprise
55-
RegisterRepoMaxRetryCount int `env:"ARGO_REPO_REGISTER_RETRY_COUNT" envDefault:"3"`
56-
RegisterRepoMaxRetryDelay int `env:"ARGO_REPO_REGISTER_RETRY_DELAY" envDefault:"10"`
54+
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
55+
RegisterRepoMaxRetryCount int `env:"ARGO_REPO_REGISTER_RETRY_COUNT" envDefault:"3" description:"Argo app registration in argo retries on deployment"`
56+
RegisterRepoMaxRetryDelay int `env:"ARGO_REPO_REGISTER_RETRY_DELAY" envDefault:"10" description:"Argo app registration in argo cd on deployment delay between retry"`
5757
}
5858

5959
func (config *ACDConfig) IsManualSyncEnabled() bool {

‎client/argocdServer/bean/connection.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ type AcdAuthConfig struct {
2525
}
2626

2727
type Config struct {
28-
Host string `env:"CD_HOST" envDefault:"localhost"`
29-
Port string `env:"CD_PORT" envDefault:"8000"`
28+
Host string `env:"CD_HOST" envDefault:"localhost" description:"Host for the devtron stack"`
29+
Port string `env:"CD_PORT" envDefault:"8000" description:"Port for pre/post-cd" `
3030
Namespace string `env:"CD_NAMESPACE" envDefault:"devtroncd"`
3131
}
3232

‎client/cron/CiStatusUpdateCron.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,8 @@ func NewCiStatusUpdateCronImpl(logger *zap.SugaredLogger, appService app.AppServ
6666
}
6767

6868
type CiWorkflowStatusUpdateConfig struct {
69-
CiWorkflowStatusUpdateCron string `env:"CI_WORKFLOW_STATUS_UPDATE_CRON" envDefault:"*/5 * * * *"`
70-
TimeoutForFailedCiBuild string `env:"TIMEOUT_FOR_FAILED_CI_BUILD" envDefault:"15"` //in minutes
69+
CiWorkflowStatusUpdateCron string `env:"CI_WORKFLOW_STATUS_UPDATE_CRON" envDefault:"*/5 * * * *" description:"Cron schedule for CI pipeline status"`
70+
TimeoutForFailedCiBuild string `env:"TIMEOUT_FOR_FAILED_CI_BUILD" envDefault:"15" description:"Timeout for Failed CI build "` //in minutes
7171
}
7272

7373
func GetCiWorkflowStatusUpdateConfig() (*CiWorkflowStatusUpdateConfig, error) {

‎client/cron/CiTriggerCron.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,8 @@ func NewCiTriggerCronImpl(logger *zap.SugaredLogger, cfg *CiTriggerCronConfig, p
6969
}
7070

7171
type CiTriggerCronConfig struct {
72-
SourceControllerCronTime int `env:"CI_TRIGGER_CRON_TIME" envDefault:"2"`
73-
PluginName string `env:"PLUGIN_NAME" envDefault:"Pull images from container repository"`
72+
SourceControllerCronTime int `env:"CI_TRIGGER_CRON_TIME" envDefault:"2" description:"For image poll plugin"`
73+
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."`
7474
}
7575

7676
func GetCiTriggerCronConfig() (*CiTriggerCronConfig, error) {

‎client/dashboard/Config.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ import (
2222

2323
// CATEGORY=INFRA_SETUP
2424
type Config struct {
25-
Host string `env:"DASHBOARD_HOST" envDefault:"localhost"`
26-
Port string `env:"DASHBOARD_PORT" envDefault:"3000"`
27-
Namespace string `env:"DASHBOARD_NAMESPACE" envDefault:"devtroncd"`
25+
Host string `env:"DASHBOARD_HOST" envDefault:"localhost" description:"Dashboard micro-service URL"`
26+
Port string `env:"DASHBOARD_PORT" envDefault:"3000" description:"Port for dashboard micro-service"`
27+
Namespace string `env:"DASHBOARD_NAMESPACE" envDefault:"devtroncd" description:"Dashboard micro-service namespace"`
2828
}
2929

3030
func GetConfig() (*Config, error) {

‎client/events/EventClient.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@ import (
3838
)
3939

4040
type EventClientConfig struct {
41-
DestinationURL string `env:"EVENT_URL" envDefault:"http://localhost:3000/notify"`
42-
NotificationMedium NotificationMedium `env:"NOTIFICATION_MEDIUM" envDefault:"rest"`
41+
DestinationURL string `env:"EVENT_URL" envDefault:"http://localhost:3000/notify" description:"Notifier service url"`
42+
NotificationMedium NotificationMedium `env:"NOTIFICATION_MEDIUM" envDefault:"rest" description:"notification medium"`
4343
}
4444
type NotificationMedium string
4545

0 commit comments

Comments
 (0)