feat(core/managed): wording + terminology tweaks for resources (#8552)

* feat(core/managed): wording + terminology tweaks for resources * feat(core/managed): switch drift to difference in resource language Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
spinnaker · Sep 10, 2020 · 6c632a9 · 6c632a9
1 parent 2395fa9
commit 6c632a9
Show file tree

Hide file tree

Showing 7 changed files with 44 additions and 51 deletions.
diff --git a/app/scripts/modules/core/src/application/config/managedResources/ManagedResourceConfig.tsx b/app/scripts/modules/core/src/application/config/managedResources/ManagedResourceConfig.tsx
@@ -30,19 +30,19 @@ const getManagementStatus = (paused: boolean) => {
     return (
       <>
         <div className="sp-padding-m sp-margin-m-bottom paused-warning">
-          <i className="fa fa-pause sp-margin-xs-right" /> <b>Continuous management of resources is paused.</b>
+          <i className="fa fa-pause sp-margin-xs-right" /> <b>Resource management is paused.</b>
         </div>
         <p className="sp-margin-l-bottom">
-          Spinnaker is configured to continuously manage some of this application's resources, but management has been
-          paused. When resumed, Spinnaker will take action to make each resource match its declarative configuration.
+          Spinnaker is configured to manage some of this application's resources, but management has been paused. When
+          resumed, Spinnaker will take action to make each resource match its desired state.
         </p>
       </>
     );
   } else {
     return (
       <>
         <p>
-          <span className="rainbow-icon">🌈</span> <b>Spinnaker is continuously managing some resources.</b>
+          <span className="rainbow-icon">🌈</span> <b>Spinnaker is managing some resources.</b>
         </p>
         <p className="sp-margin-l-bottom">
           If you need to temporarily stop Spinnaker from managing resources — for example, if something is wrong and

diff --git a/app/scripts/modules/core/src/managed/DeployingIntoManagedClusterWarning.tsx b/app/scripts/modules/core/src/managed/DeployingIntoManagedClusterWarning.tsx
@@ -45,9 +45,9 @@ export const DeployingIntoManagedClusterWarning = ({ app, formik }: IDeployingIn
   return (
     <div className="alert alert-danger">
       <p>
-        <b>🌈 Spinnaker is continuously managing this resource.</b>
+        <b>🌈 Spinnaker is managing this resource.</b>
       </p>
-      <p>Any changes you make to this cluster will be stomped in favor of the declarative configuration.</p>
+      <p>Any changes you make to this cluster will be overridden in favor of the desired state.</p>
       <p>If you need to manually deploy a new version of this server group, you should pause management.</p>
       <div className="sp-margin-m-top">
         <button className="passive" onClick={pauseResource}>

diff --git a/app/scripts/modules/core/src/managed/EnvironmentsHeader.tsx b/app/scripts/modules/core/src/managed/EnvironmentsHeader.tsx
@@ -30,7 +30,7 @@ const environmentHeaderInfo: {
   running: {
     description: null,
     icon: 'runManagement',
-    title: (info: string) => `Spinnaker is continuously managing ${info} resources.`,
+    title: (info: string) => `Spinnaker is managing ${info} resources.`,
   },
   paused: {
     description: 'Any actions made will take effect once management is resumed.',

diff --git a/app/scripts/modules/core/src/managed/ManagedResourceDetailsIndicator.tsx b/app/scripts/modules/core/src/managed/ManagedResourceDetailsIndicator.tsx
@@ -40,10 +40,10 @@ export const ManagedResourceDetailsIndicator = ({
   const helpText = (
     <>
       <p>
-        <b>Spinnaker is continuously managing this resource.</b>
+        <b>Spinnaker is managing this resource.</b>
       </p>
       <p>
-        Changes made in the UI will be stomped in favor of the existing declarative configuration.{' '}
+        If a difference from the desired state is detected, Spinnaker will act to correct it.{' '}
         <a
           target="_blank"
           onClick={() => logClick('Learn More', id)}

diff --git a/app/scripts/modules/core/src/managed/ManagedResourceHistoryModal.tsx b/app/scripts/modules/core/src/managed/ManagedResourceHistoryModal.tsx
@@ -62,12 +62,12 @@ const viewConfigurationByEventType = {
     level: 'info',
   },
   ResourceDeltaDetected: {
-    displayName: 'Drift detected',
+    displayName: 'Difference detected',
     iconClass: 'icon-md-delta-detected',
     level: 'info',
   },
   ResourceDeltaResolved: {
-    displayName: 'Drift resolved',
+    displayName: 'Difference resolved',
     iconClass: 'icon-md-delta-resolved',
     level: 'info',
   },

diff --git a/app/scripts/modules/core/src/managed/managedResourceStatusConfig.tsx b/app/scripts/modules/core/src/managed/managedResourceStatusConfig.tsx
@@ -37,11 +37,10 @@ export const viewConfigurationByStatus: { [status in ManagedResourceStatus]: IVi
     popoverContents: (resourceSummary: IManagedResourceSummary) => (
       <>
         <p>
-          <b>Action is being taken to resolve a drift from the declarative configuration.</b>
+          <b>Spinnaker is taking action to resolve a difference from this resource's desired state.</b>
         </p>
         <p>
-          Check this resource's History to see details and track the work currently in progress.{' '}
-          <LearnMoreLink resourceSummary={resourceSummary} />
+          You can click History to see more. <LearnMoreLink resourceSummary={resourceSummary} />
         </p>
       </>
     ),
@@ -52,11 +51,10 @@ export const viewConfigurationByStatus: { [status in ManagedResourceStatus]: IVi
     popoverContents: (resourceSummary: IManagedResourceSummary) => (
       <>
         <p>
-          <b>Spinnaker has started continuously managing this resource.</b>
+          <b>Spinnaker has started managing this resource.</b>
         </p>
         <p>
-          If its actual configuration drifts from the declarative configuration, Spinnaker will automatically correct
-          it. Changes made in the UI will be stomped in favor of the declarative configuration.{' '}
+          If a difference from the desired state is detected, Spinnaker will act to correct it.{' '}
           <LearnMoreLink resourceSummary={resourceSummary} />
         </p>
       </>
@@ -68,11 +66,11 @@ export const viewConfigurationByStatus: { [status in ManagedResourceStatus]: IVi
     popoverContents: (resourceSummary: IManagedResourceSummary) => (
       <>
         <p>
-          <b>A drift from the declarative configuration was detected.</b>
+          <b>Spinnaker detected a difference from the desired state.</b>
         </p>
         <p>
-          Spinnaker will automatically take action to bring this resource back to its desired state. Check the History
-          to see details and track progress. <LearnMoreLink resourceSummary={resourceSummary} />
+          In a moment, Spinnaker will take action to bring this resource back to its desired state. You can click
+          History to see more. <LearnMoreLink resourceSummary={resourceSummary} />
         </p>
       </>
     ),
@@ -87,8 +85,8 @@ export const viewConfigurationByStatus: { [status in ManagedResourceStatus]: IVi
           <b>Waiting for a temporary issue to pass.</b>
         </p>
         <p>
-          Something required for management is temporarily experiencing issues. Automatic action can't be taken right
-          now, but will likely resume soon. Check the History for details.{' '}
+          Something required for management is temporarily experiencing issues. Spinnaker can't take action right now,
+          but should be able to soon. You can click History to see more.{' '}
           <LearnMoreLink resourceSummary={resourceSummary} />
         </p>
       </>
@@ -104,8 +102,8 @@ export const viewConfigurationByStatus: { [status in ManagedResourceStatus]: IVi
           <b>Waiting for a missing dependency to become available.</b>
         </p>
         <p>
-          Something required for management isn't ready yet. Automatic action can't be taken right now, but will resume
-          once the necessary dependencies exist. Check the History for details.{' '}
+          Something required for management isn't ready yet. Spinnaker can't take action right now, but will resume once
+          the missing dependencies exist. You can click History to see more.{' '}
           <LearnMoreLink resourceSummary={resourceSummary} />
         </p>
       </>
@@ -120,9 +118,9 @@ export const viewConfigurationByStatus: { [status in ManagedResourceStatus]: IVi
           <b>Something went wrong.</b>
         </p>
         <p>
-          Spinnaker is configured to continuously manage this resource, but something went wrong trying to check its
-          current state. Automatic action can't be taken right now, and manual intervention might be required. Check the
-          History for details. <LearnMoreLink resourceSummary={resourceSummary} />
+          Something went wrong while trying to check this resource's current state. Spinnaker can't take action right
+          now, and manual intervention might be required. You can click History to see more.{' '}
+          <LearnMoreLink resourceSummary={resourceSummary} />
         </p>
       </>
     ),
@@ -133,10 +131,10 @@ export const viewConfigurationByStatus: { [status in ManagedResourceStatus]: IVi
     popoverContents: (resourceSummary: IManagedResourceSummary) => (
       <>
         <p>
-          <b>Spinnaker is continuously managing this resource.</b>
+          <b>Spinnaker is managing this resource.</b>
         </p>
         <p>
-          Changes made in the UI will be stomped in favor of the declarative configuration.{' '}
+          If a difference from the desired state is detected, Spinnaker will act to correct it.{' '}
           <LearnMoreLink resourceSummary={resourceSummary} />
         </p>
       </>
@@ -148,17 +146,17 @@ export const viewConfigurationByStatus: { [status in ManagedResourceStatus]: IVi
     popoverContents: (resourceSummary: IManagedResourceSummary, application: Application) => (
       <>
         <p>
-          <b>Continuous management is paused.</b>
+          <b>Management is paused.</b>
         </p>
         {application.isManagementPaused && (
           <p>
-            Spinnaker is configured to continuously manage this resource, but management for the entire application is
-            temporarily paused. <LearnMoreLink resourceSummary={resourceSummary} />
+            Spinnaker is configured to manage this resource, but management for the entire application is temporarily
+            paused. <LearnMoreLink resourceSummary={resourceSummary} />
           </p>
         )}
         {!application.isManagementPaused && (
           <p>
-            Spinnaker is configured to continuously manage this resource, but management has been temporarily paused.{' '}
+            Spinnaker is configured to manage this resource, but management has been temporarily paused.{' '}
             <LearnMoreLink resourceSummary={resourceSummary} />
           </p>
         )}
@@ -171,12 +169,11 @@ export const viewConfigurationByStatus: { [status in ManagedResourceStatus]: IVi
     popoverContents: (resourceSummary: IManagedResourceSummary) => (
       <>
         <p>
-          <b>Continuous management was just resumed.</b>
+          <b>Management was just resumed.</b>
         </p>
         <p>
-          Management was resumed after being temporarily paused. If Spinnaker detects that a drift from the declarative
-          configuration occurred while paused, it will take automatic action to resolve the drift.{' '}
-          <LearnMoreLink resourceSummary={resourceSummary} />
+          Management was resumed after being temporarily paused. If Spinnaker detects that a difference from the desired
+          state occurred while paused, it will act to correct it. <LearnMoreLink resourceSummary={resourceSummary} />
         </p>
       </>
     ),
@@ -187,12 +184,11 @@ export const viewConfigurationByStatus: { [status in ManagedResourceStatus]: IVi
     popoverContents: (resourceSummary: IManagedResourceSummary) => (
       <>
         <p>
-          <b>A drift from the declarative configuration was detected, but Spinnaker hasn't been able to correct it.</b>
+          <b>Spinnaker detected a difference from the desired state, but hasn't been able to correct it.</b>
         </p>
         <p>
-          Spinnaker has been trying to correct a detected drift, but taking automatic action hasn't helped. Manual
-          intervention might be required. Check the History for details.{' '}
-          <LearnMoreLink resourceSummary={resourceSummary} />
+          Spinnaker has been trying to correct a difference, but taking action hasn't helped. Manual intervention might
+          be required. You can click History to see more. <LearnMoreLink resourceSummary={resourceSummary} />
         </p>
       </>
     ),
@@ -206,8 +202,8 @@ export const viewConfigurationByStatus: { [status in ManagedResourceStatus]: IVi
           <b>Unable to determine resource status.</b>
         </p>
         <p>
-          Spinnaker is configured to continuously manage this resource, but its current status can't be calculated right
-          now. <LearnMoreLink resourceSummary={resourceSummary} />
+          Spinnaker is configured to manage this resource, but can't calculate its current status.{' '}
+          <LearnMoreLink resourceSummary={resourceSummary} />
         </p>
       </>
     ),

diff --git a/app/scripts/modules/core/src/managed/toggleResourceManagement.tsx b/app/scripts/modules/core/src/managed/toggleResourceManagement.tsx
@@ -21,8 +21,8 @@ const viewConfigurationByStatus: { [status in ManagedResourceStatus]?: IToggleCo
         <div className="horizontal top sp-padding-m alert alert-warning">
           <i className="fa fa-exclamation-triangle sp-margin-m-right sp-margin-xs-top" />
           <span>
-            Pausing management will not interrupt the action Spinnaker is currently performing to resolve the drift in
-            configuration.
+            Pausing management will not interrupt the action Spinnaker is currently performing to resolve the difference
+            from desired state.
           </span>
         </div>
       </p>
@@ -85,17 +85,14 @@ const PopoverToggleBodyText = ({ resourceSummary }: { resourceSummary: IManagedR
   if (isPaused) {
     return (
       <>
-        <p>Spinnaker will resume taking action to resolve drift from the declarative configuration.</p>
+        <p>Spinnaker will resume taking action to correct differences from the desired state.</p>
         <MultiRegionWarning resourceSummary={resourceSummary} />
       </>
     );
   } else {
     return (
       <>
-        <p>
-          While a resource is paused, Spinnaker will not take action to resolve drift from the declarative
-          configuration.
-        </p>
+        <p>While a resource is paused, Spinnaker will not take action to correct differences from the desired state.</p>
         {viewConfigurationByStatus[status]?.pauseWarning}
         <MultiRegionWarning resourceSummary={resourceSummary} />
       </>
@@ -125,7 +122,7 @@ const BodyText = ({ resourceSummary }: { resourceSummary: IManagedResourceSummar
   return (
     <>
       <p>
-        🌈 <b>Spinnaker is continuously managing this resource.</b>
+        🌈 <b>Spinnaker is managing this resource.</b>
       </p>
       <p>
         If you need to temporarily stop Spinnaker from managing this resource — for example, if something is wrong and