From d89cad0d9edd2baaa01f668d8ed12eca62ee1a48 Mon Sep 17 00:00:00 2001
From: Michael Abashian <mabashian@users.noreply.github.com>
Date: Wed, 31 May 2023 12:31:55 -0400
Subject: [PATCH] Adds managed_by_policy checkbox to instances form.  Adds
 warnings when associating or disassociating instances from instance groups.
 (#13994)

---
 .../AssociateModal/AssociateModal.js          |  2 +
 .../DisassociateButton/DisassociateButton.js  | 12 ++++-
 .../InstanceDetails/InstanceDetails.js        | 23 +++++++++-
 .../InstanceGroup/Instances/InstanceList.js   | 46 ++++++++++++++++++-
 .../screens/Instances/Shared/InstanceForm.js  |  7 +++
 .../Instances/Shared/InstanceForm.test.js     |  1 +
 6 files changed, 87 insertions(+), 4 deletions(-)

diff --git a/awx/ui/src/components/AssociateModal/AssociateModal.js b/awx/ui/src/components/AssociateModal/AssociateModal.js
index 3b42c66915..88e5459910 100644
--- a/awx/ui/src/components/AssociateModal/AssociateModal.js
+++ b/awx/ui/src/components/AssociateModal/AssociateModal.js
@@ -27,6 +27,7 @@ function AssociateModal({
   isModalOpen = false,
   displayKey = 'name',
   ouiaId,
+  modalNote,
 }) {
   const history = useHistory();
   const { selected, handleSelect } = useSelected([]);
@@ -120,6 +121,7 @@ function AssociateModal({
         </Button>,
       ]}
     >
+      {modalNote}
       <OptionsList
         displayKey={displayKey}
         contentError={contentError}
diff --git a/awx/ui/src/components/DisassociateButton/DisassociateButton.js b/awx/ui/src/components/DisassociateButton/DisassociateButton.js
index 9b0c8278b1..4d3343a6bb 100644
--- a/awx/ui/src/components/DisassociateButton/DisassociateButton.js
+++ b/awx/ui/src/components/DisassociateButton/DisassociateButton.js
@@ -1,5 +1,13 @@
 import React, { useState, useEffect, useContext } from 'react';
-import { arrayOf, func, shape, string, oneOfType, number } from 'prop-types';
+import {
+  arrayOf,
+  func,
+  shape,
+  string,
+  oneOfType,
+  number,
+  node,
+} from 'prop-types';
 
 import { t } from '@lingui/macro';
 import { Button, Tooltip, DropdownItem } from '@patternfly/react-core';
@@ -180,7 +188,7 @@ DisassociateButton.propTypes = {
       })
     ),
   ]),
-  modalNote: string,
+  modalNote: node,
   modalTitle: string,
   onDisassociate: func.isRequired,
 };
diff --git a/awx/ui/src/screens/InstanceGroup/InstanceDetails/InstanceDetails.js b/awx/ui/src/screens/InstanceGroup/InstanceDetails/InstanceDetails.js
index e0dd8a09fa..3425f86cea 100644
--- a/awx/ui/src/screens/InstanceGroup/InstanceDetails/InstanceDetails.js
+++ b/awx/ui/src/screens/InstanceGroup/InstanceDetails/InstanceDetails.js
@@ -1,7 +1,7 @@
 import React, { useCallback, useEffect, useState } from 'react';
 
 import { useParams, useHistory } from 'react-router-dom';
-import { t, Plural } from '@lingui/macro';
+import { t, Trans, Plural } from '@lingui/macro';
 import {
   Button,
   Progress,
@@ -71,6 +71,10 @@ function InstanceDetails({ setBreadcrumb, instanceGroup }) {
   const [showHealthCheckAlert, setShowHealthCheckAlert] = useState(false);
   const [forks, setForks] = useState();
 
+  const policyRulesDocsLink = `${getDocsBaseUrl(
+    config
+  )}/html/administration/containers_instance_groups.html#ag-instance-group-policies`;
+
   const {
     isLoading,
     error: contentError,
@@ -319,6 +323,23 @@ function InstanceDetails({ setBreadcrumb, instanceGroup }) {
               itemsToDisassociate={[instance]}
               isProtectedInstanceGroup={instanceGroup.name === 'controlplane'}
               modalTitle={t`Disassociate instance from instance group?`}
+              modalNote={
+                instance.managed_by_policy ? (
+                  <Trans>
+                    <b>
+                      Note: This instance may be re-associated with this
+                      instance group if it is managed by{' '}
+                      <a
+                        href={policyRulesDocsLink}
+                        target="_blank"
+                        rel="noopener noreferrer"
+                      >
+                        policy rules.
+                      </a>
+                    </b>
+                  </Trans>
+                ) : null
+              }
             />
           )}
           <InstanceToggle
diff --git a/awx/ui/src/screens/InstanceGroup/Instances/InstanceList.js b/awx/ui/src/screens/InstanceGroup/Instances/InstanceList.js
index cac7daa04d..cc638be096 100644
--- a/awx/ui/src/screens/InstanceGroup/Instances/InstanceList.js
+++ b/awx/ui/src/screens/InstanceGroup/Instances/InstanceList.js
@@ -1,5 +1,5 @@
 import React, { useCallback, useEffect, useState } from 'react';
-import { t } from '@lingui/macro';
+import { t, Trans } from '@lingui/macro';
 import { useLocation, useParams } from 'react-router-dom';
 import 'styled-components/macro';
 
@@ -22,6 +22,8 @@ import useRequest, {
 import useSelected from 'hooks/useSelected';
 import { InstanceGroupsAPI, InstancesAPI } from 'api';
 import { getQSConfig, parseQueryString, mergeParams } from 'util/qs';
+import getDocsBaseUrl from 'util/getDocsBaseUrl';
+import { useConfig } from 'contexts/Config';
 import HealthCheckButton from 'components/HealthCheckButton/HealthCheckButton';
 import HealthCheckAlert from 'components/HealthCheckAlert';
 import InstanceListItem from './InstanceListItem';
@@ -33,6 +35,7 @@ const QS_CONFIG = getQSConfig('instance', {
 });
 
 function InstanceList({ instanceGroup }) {
+  const config = useConfig();
   const [isModalOpen, setIsModalOpen] = useState(false);
   const [showHealthCheckAlert, setShowHealthCheckAlert] = useState(false);
   const [pendingHealthCheck, setPendingHealthCheck] = useState(false);
@@ -40,6 +43,10 @@ function InstanceList({ instanceGroup }) {
   const location = useLocation();
   const { id: instanceGroupId } = useParams();
 
+  const policyRulesDocsLink = `${getDocsBaseUrl(
+    config
+  )}/html/administration/containers_instance_groups.html#ag-instance-group-policies`;
+
   const {
     result: {
       instances,
@@ -262,6 +269,25 @@ function InstanceList({ instanceGroup }) {
                 itemsToDisassociate={selected}
                 modalTitle={t`Disassociate instance from instance group?`}
                 isProtectedInstanceGroup={instanceGroup.name === 'controlplane'}
+                modalNote={
+                  selected.some(
+                    (instance) => instance.managed_by_policy === true
+                  ) ? (
+                    <Trans>
+                      <b>
+                        Note: Instances may be re-associated with this instance
+                        group if they are managed by{' '}
+                        <a
+                          href={policyRulesDocsLink}
+                          target="_blank"
+                          rel="noopener noreferrer"
+                        >
+                          policy rules.
+                        </a>
+                      </b>
+                    </Trans>
+                  ) : null
+                }
               />,
               <HealthCheckButton
                 isDisabled={!canAdd || !canRunHealthCheck}
@@ -321,6 +347,24 @@ function InstanceList({ instanceGroup }) {
             { key: 'hostname', name: t`Name` },
             { key: 'node_type', name: t`Node Type` },
           ]}
+          modalNote={
+            <b>
+              <Trans>
+                <b>
+                  Note: Manually associated instances may be automatically
+                  disassociated from an instance group if the instance is
+                  managed by{' '}
+                  <a
+                    href={policyRulesDocsLink}
+                    target="_blank"
+                    rel="noopener noreferrer"
+                  >
+                    policy rules.
+                  </a>
+                </b>
+              </Trans>
+            </b>
+          }
         />
       )}
       {error && (
diff --git a/awx/ui/src/screens/Instances/Shared/InstanceForm.js b/awx/ui/src/screens/Instances/Shared/InstanceForm.js
index 53fefbef7c..9b8ffa2ce7 100644
--- a/awx/ui/src/screens/Instances/Shared/InstanceForm.js
+++ b/awx/ui/src/screens/Instances/Shared/InstanceForm.js
@@ -58,6 +58,12 @@ function InstanceFormFields() {
           label={t`Enable Instance`}
           tooltip={t`Set the instance enabled or disabled. If disabled, jobs will not be assigned to this instance.`}
         />
+        <CheckboxField
+          id="managed-by-policy"
+          name="managed_by_policy"
+          label={t`Managed by Policy`}
+          tooltip={t`Controls whether or not this instance is managed by policy. If enabled, the instance will be available for automatic assignment to and unassignment from instance groups based on policy rules.`}
+        />
       </FormGroup>
     </>
   );
@@ -79,6 +85,7 @@ function InstanceForm({
           node_state: 'installed',
           listener_port: 27199,
           enabled: true,
+          managed_by_policy: true,
         }}
         onSubmit={(values) => {
           handleSubmit(values);
diff --git a/awx/ui/src/screens/Instances/Shared/InstanceForm.test.js b/awx/ui/src/screens/Instances/Shared/InstanceForm.test.js
index c2cf6d9a0a..263b5c32e7 100644
--- a/awx/ui/src/screens/Instances/Shared/InstanceForm.test.js
+++ b/awx/ui/src/screens/Instances/Shared/InstanceForm.test.js
@@ -89,6 +89,7 @@ describe('<InstanceForm />', () => {
     expect(handleSubmit).toBeCalledWith({
       description: 'This is a repeat song',
       enabled: true,
+      managed_by_policy: true,
       hostname: 'new Foo',
       listener_port: 'This is a repeat song',
       node_state: 'installed',