From 2ac70b1eb64e31b2bbf1af4717ec62a9a76ae625 Mon Sep 17 00:00:00 2001 From: Oscar Zhou <100548325+oscarzhou-portainer@users.noreply.github.com> Date: Tue, 13 Jun 2023 15:32:10 +1200 Subject: [PATCH] feat(gitops): reword automatic update to gitops update for ui and docs (#9067) --- api/http/handler/stacks/create_compose_stack.go | 2 +- api/http/handler/stacks/create_swarm_stack.go | 2 +- api/portainer.go | 2 +- api/stacks/stackbuilders/stack_payload.go | 2 +- .../docker-features-configuration.html | 2 +- app/kubernetes/views/configure/configure.html | 2 +- app/react/portainer/environments/types.ts | 4 ++-- .../gitops/AutoUpdateFieldset/AutoUpdateFieldset.tsx | 2 +- app/react/portainer/gitops/TimeWindowDisplay.tsx | 2 +- 9 files changed, 10 insertions(+), 10 deletions(-) diff --git a/api/http/handler/stacks/create_compose_stack.go b/api/http/handler/stacks/create_compose_stack.go index cff765e93..8c695c209 100644 --- a/api/http/handler/stacks/create_compose_stack.go +++ b/api/http/handler/stacks/create_compose_stack.go @@ -171,7 +171,7 @@ type composeStackFromGitRepositoryPayload struct { ComposeFile string `example:"docker-compose.yml" default:"docker-compose.yml"` // Applicable when deploying with multiple stack files AdditionalFiles []string `example:"[nz.compose.yml, uat.compose.yml]"` - // Optional auto update configuration + // Optional GitOps update configuration AutoUpdate *portainer.AutoUpdateSettings // A list of environment variables used during stack deployment Env []portainer.Pair diff --git a/api/http/handler/stacks/create_swarm_stack.go b/api/http/handler/stacks/create_swarm_stack.go index 22117f68b..e84b907bb 100644 --- a/api/http/handler/stacks/create_swarm_stack.go +++ b/api/http/handler/stacks/create_swarm_stack.go @@ -130,7 +130,7 @@ type swarmStackFromGitRepositoryPayload struct { ComposeFile string `example:"docker-compose.yml" default:"docker-compose.yml"` // Applicable when deploying with multiple stack files AdditionalFiles []string `example:"[nz.compose.yml, uat.compose.yml]"` - // Optional auto update configuration + // Optional GitOps update configuration AutoUpdate *portainer.AutoUpdateSettings // TLSSkipVerify skips SSL verification when cloning the Git repository TLSSkipVerify bool `example:"false"` diff --git a/api/portainer.go b/api/portainer.go index b5354c0e4..0e23c60c3 100644 --- a/api/portainer.go +++ b/api/portainer.go @@ -1017,7 +1017,7 @@ type ( UpdatedBy string `example:"bob"` // Only applies when deploying stack with multiple files AdditionalFiles []string `json:"AdditionalFiles"` - // The auto update settings of a git stack + // The GitOps update settings of a git stack AutoUpdate *AutoUpdateSettings `json:"AutoUpdate"` // The stack deployment option Option *StackOption `json:"Option"` diff --git a/api/stacks/stackbuilders/stack_payload.go b/api/stacks/stackbuilders/stack_payload.go index 86a90456d..05c66a569 100644 --- a/api/stacks/stackbuilders/stack_payload.go +++ b/api/stacks/stackbuilders/stack_payload.go @@ -17,7 +17,7 @@ type StackPayload struct { Webhook string // A list of environment(endpoint) variables used during stack deployment Env []portainer.Pair - // Optional auto update configuration + // Optional GitOps update configuration AutoUpdate *portainer.AutoUpdateSettings // Whether the stack is from a app template FromAppTemplate bool `example:"false"` diff --git a/app/docker/views/docker-features-configuration/docker-features-configuration.html b/app/docker/views/docker-features-configuration/docker-features-configuration.html index db3c6d697..ba24df82e 100644 --- a/app/docker/views/docker-features-configuration/docker-features-configuration.html +++ b/app/docker/views/docker-features-configuration/docker-features-configuration.html @@ -49,7 +49,7 @@ label="'Enable Change Window'" label-class="'col-sm-7 col-lg-4'" feature-id="$ctrl.limitedFeatureAutoUpdate" - tooltip="'Specify a time-frame during which automatic updates can occur in this environment.'" + tooltip="'Specify a time-frame during which GitOps updates can occur in this environment.'" on-change="($ctrl.onToggleAutoUpdate)" > diff --git a/app/kubernetes/views/configure/configure.html b/app/kubernetes/views/configure/configure.html index 23033abde..73556aa24 100644 --- a/app/kubernetes/views/configure/configure.html +++ b/app/kubernetes/views/configure/configure.html @@ -104,7 +104,7 @@ name="'disableSysctlSettingForRegularUsers'" label="'Enable Change Window'" feature-id="ctrl.limitedFeatureAutoWindow" - tooltip="'Automatic updates to stacks or applications outside the defined change window will not occur.'" + tooltip="'GitOps updates to stacks or applications outside the defined change window will not occur.'" on-change="(ctrl.onToggleAutoUpdate)" label-class="'col-sm-5 col-lg-4 px-0 !m-0'" switch-class="'col-sm-8 text-muted'" diff --git a/app/react/portainer/environments/types.ts b/app/react/portainer/environments/types.ts index 27e960a34..3536bd2d6 100644 --- a/app/react/portainer/environments/types.ts +++ b/app/react/portainer/environments/types.ts @@ -124,7 +124,7 @@ export type DeploymentOptions = { }; /** - * EndpointChangeWindow determine when automatic stack/app updates may occur + * EndpointChangeWindow determine when GitOps stack/app updates may occur */ interface EndpointChangeWindow { Enabled: boolean; @@ -161,7 +161,7 @@ export type Environment = { EnableImageNotification: boolean; LocalTimeZone?: string; - /** Automatic update change window restriction for stacks and apps */ + /** GitOps update change window restriction for stacks and apps */ ChangeWindow: EndpointChangeWindow; }; diff --git a/app/react/portainer/gitops/AutoUpdateFieldset/AutoUpdateFieldset.tsx b/app/react/portainer/gitops/AutoUpdateFieldset/AutoUpdateFieldset.tsx index 978f66251..896a7b9c0 100644 --- a/app/react/portainer/gitops/AutoUpdateFieldset/AutoUpdateFieldset.tsx +++ b/app/react/portainer/gitops/AutoUpdateFieldset/AutoUpdateFieldset.tsx @@ -38,7 +38,7 @@ export function AutoUpdateFieldset({ handleChange({ RepositoryAutomaticUpdates: value }) diff --git a/app/react/portainer/gitops/TimeWindowDisplay.tsx b/app/react/portainer/gitops/TimeWindowDisplay.tsx index 76ed3bbaa..d6a85db95 100644 --- a/app/react/portainer/gitops/TimeWindowDisplay.tsx +++ b/app/react/portainer/gitops/TimeWindowDisplay.tsx @@ -37,7 +37,7 @@ function TimeWindowDisplay() { return ( - A change window is enabled, automatic updates will not occur outside of{' '} + A change window is enabled, GitOps updates will not occur outside of{' '} {shortTime(startTimeUtc)} - {shortTime(endTimeUtc)} UTC ( {shortTime(startTimeLocal)} -{shortTime(endTimeLocal)}{' '}