Merge pull request #1647 from malayparida2000/external

Add info alert for In-transit Encryption in external mode
red-hat-storage · Nov 20, 2024 · 1b11f10 · 1b11f10
2 parents 1b07337 + 3da81f1
commit 1b11f10
Show file tree

Hide file tree

Showing 3 changed files with 46 additions and 3 deletions.
diff --git a/locales/en/plugin__odf-console.json b/locales/en/plugin__odf-console.json
@@ -981,7 +981,9 @@
   "MultiCloud Object Gateway supports encryption for objects by default.": "MultiCloud Object Gateway supports encryption for objects by default.",
   "Enable data encryption for block and file storage": "Enable data encryption for block and file storage",
   "Enable encryption": "Enable encryption",
-  "A secure mode that encrypts all data passing over the network": "A secure mode that encrypts all data passing over the network",
+  "Encrypts all Ceph traffic including data, using Ceph msgrv2": "Encrypts all Ceph traffic including data, using Ceph msgrv2",
+  "Verify your RHCS cluster has the necessary in-transit encryption settings configured to enable in-transit encryption on your external cluster. Refer to the documentation for detailed configuration steps.": "Verify your RHCS cluster has the necessary in-transit encryption settings configured to enable in-transit encryption on your external cluster. Refer to the documentation for detailed configuration steps.",
+  "Documentation link": "Documentation link",
   "An error has occurred: {{error}}": "An error has occurred: {{error}}",
   "The uploaded file is not a valid JSON file": "The uploaded file is not a valid JSON file",
   "External storage system metadata": "External storage system metadata",

diff --git a/...reate-storage-system/create-storage-system-steps/security-and-network-step/encryption.tsx b/...reate-storage-system/create-storage-system-steps/security-and-network-step/encryption.tsx
@@ -1,9 +1,17 @@
 import * as React from 'react';
 import { ValidationType } from '@odf/core/types';
 import { AdvancedSubscription } from '@odf/shared/badges/advanced-subscription';
+import { inTransitEncryptionSettingsForRHCS } from '@odf/shared/constants/doc';
 import { FieldLevelHelp } from '@odf/shared/generic/FieldLevelHelp';
+import { DOC_VERSION as odfDocVersion } from '@odf/shared/hooks';
 import { useCustomTranslation } from '@odf/shared/useCustomTranslationHook';
-import { Checkbox, FormGroup, Form } from '@patternfly/react-core';
+import {
+  Alert,
+  AlertVariant,
+  Checkbox,
+  FormGroup,
+  Form,
+} from '@patternfly/react-core';
 import { KMSEmptyState } from '../../../../constants';
 import { KMSConfigure } from '../../../kms-config/kms-config';
 import { ValidationMessage } from '../../../utils/common-odf-install-el';
@@ -291,13 +299,34 @@ export const Encryption: React.FC<EncryptionProps> = ({
             data-checked-state={encryption.inTransit}
             label={t('In-transit encryption')}
             description={t(
-              'A secure mode that encrypts all data passing over the network'
+              'Encrypts all Ceph traffic including data, using Ceph msgrv2'
             )}
             onChange={(_event, checked: boolean) =>
               handleInTransitEncryptionOnChange(checked)
             }
           />
         )}
+        {isExternal && encryption.inTransit && (
+          <Alert
+            variant={AlertVariant.info}
+            isInline
+            className="pf-v5-u-mt-sm"
+            title={
+              <>
+                {t(
+                  'Verify your RHCS cluster has the necessary in-transit encryption settings configured to enable in-transit encryption on your external cluster. Refer to the documentation for detailed configuration steps.'
+                )}{' '}
+                <a
+                  href={inTransitEncryptionSettingsForRHCS(odfDocVersion)}
+                  target="_blank"
+                  rel="noopener noreferrer"
+                >
+                  {t('Documentation link')}
+                </a>
+              </>
+            }
+          />
+        )}
       </FormGroup>
       {!encryption.hasHandled && (
         <ValidationMessage validation={ValidationType.ENCRYPTION} />

diff --git a/packages/shared/src/constants/doc.ts b/packages/shared/src/constants/doc.ts
@@ -14,3 +14,15 @@ export const odfDRDocApplyPolicy = (odfDocVersion) =>
   `${odfDRDocHome(
     odfDocVersion
   )}#apply-drpolicy-to-sample-application_manage-dr`;
+
+export const odfDeployExternalMode = (odfDocVersion) =>
+  `${odfDocBasePath(
+    odfDocVersion
+  )}/deploying_openshift_data_foundation_in_external_mode`;
+
+export const inTransitEncryptionSettingsForRHCS = (
+  odfDocVersion: string
+): string =>
+  `${odfDeployExternalMode(
+    odfDocVersion
+  )}/deploy-openshift-data-foundation-using-red-hat-ceph-storage#creating-an-openshift-data-foundation-cluster-service-for-external-storage_ceph-external`;