Add support for Azure RedhatOpenshift Clusters #4152

super-harsh · 2024-07-08T06:35:16Z

What this PR does / why we need it:

This PR adds support for 2023-11-22 Azure RedhatOpenshift Clusters.

Special notes for your reviewer:

Have excluded samples testing and controller tests from running in live mode since we require Service Principal credentials to run them.

If applicable:

this PR contains documentation
this PR contains tests
this PR contains YAML Samples

v2/internal/testcommon/vcr/redact.go

…rom configmap

matthchr · 2024-07-11T20:48:53Z

Looks like an APIManagement test flake possibly? May need to re-run test-generator.

docs/hugo/content/reference/_index.md

v2/azure-arm.yaml

v2/internal/controllers/crd_redhatopenshift_openshiftcluster_20230401_test.go

matthchr · 2024-07-11T20:55:40Z

v2/internal/controllers/crd_redhatopenshift_openshiftcluster_20230401_test.go

+	"github.com/Azure/azure-service-operator/v2/internal/util/to"
+)
+
+// TODO: TO re-record this test, create a new service principal and follow the todos below in the test code.


minor: Clarify that it's ARO that requires an SP, so there is no workaround.

Maybe by saying something like:

Suggested change

// TODO: TO re-record this test, create a new service principal and follow the todos below in the test code.

// TODO: To re-record this test, create a new service principal and save its details into the

// TODO: ARO_CLIENT_ID, ARO_CLIENT_SECRET, and ARO_PRINCIPAL_ID variables.

// TODO: This is required because the ARO resource requires a service principal for input currently. Hopefully

// TODO: we can revisit this in the future when they support other options.

v2/internal/controllers/crd_redhatopenshift_openshiftcluster_20230401_test.go

v2/samples/redhatopenshift/v1api/refs/v1api20220401_roleassignment_from_sp_to_vnet.yaml

v2/internal/testcommon/vcr/redact.go

matthchr · 2024-07-11T21:05:53Z

v2/internal/testcommon/vcr/redact.go

@@ -131,6 +132,18 @@ func hidePasswords(s string) string {
 	return passwordMatcher.ReplaceAllLiteralString(s, "\"{PASSWORD}\"")
 }

+var (
+	secretMatcher  = regexp.MustCompile(`"([A-Za-z]+)?[Ss]ecret":".*"`)


If we do need this, consider leaving a comment describing what it does and why we need it in addition to the other matchers. See for example the matchers here: toolkit/testhttprecorder/recorder.go

In fact yours maybe should go there too?

matthchr · 2024-07-15T17:42:09Z

v2/internal/controllers/crd_redhatopenshift_openshiftcluster_20230401_test.go

+	secretName := "aro-secret"
+	secretKey := "client-secret"
+	// TODO: Replace the principalID, clientSecret and clientId vars below with principalId, clientSecret and clientId of your SP
+	principalId := "5c6be76c-5fc4-4817-992d-22027b44c402"


I think these should be env variables too, or hardcoded to 00000's GUIDs?

Is the issue with changing these that the test recordings don't pass then?

matthchr · 2024-08-15T23:55:48Z

v2/api/redhatopenshift/v1api20231122/structure.txt

+│   │   │   └── "Enabled"
+│   │   └── ServiceCidr: *string
+│   ├── Owner: *genruntime.KnownResourceReference
+│   ├── ProvisioningState: *Enum (7 values)


I think you should be able to mark this field as ReadOnly because it's not really supposed to be an input?

v2/internal/controllers/crd_redhatopenshift_openshiftcluster_20230401_test.go

matthchr · 2024-08-15T23:57:47Z

v2/internal/controllers/crd_redhatopenshift_openshiftcluster_20230401_test.go

+
+	clientSecretRef := tc.CreateSecret(secretName, secretKey, details.clientSecret)
+
+	tc.WithLiteralRedaction(details.objectId, "{REDACTED}")


minor: Consider leaving a comment here around "ensure we redact the secret/clientid details of the SP we're using in the recordings"

If you think that's obvious though, feel free to ignore this.

v2/internal/controllers/crd_redhatopenshift_openshiftcluster_20230401_test.go

matthchr · 2024-08-15T23:59:12Z

v2/internal/controllers/crd_redhatopenshift_openshiftcluster_20230401_test.go

+		clientSecret = secret
+	}
+
+	tc.WithLiteralRedaction(clientId, nilUUID)


Don't you already do this above?

Remove the duplicate code, either above or here?

matthchr · 2024-08-16T00:03:08Z

v2/internal/controllers/crd_redhatopenshift_openshiftcluster_20230401_test.go

+	}
+
+	vnet := newVNet(tc, testcommon.AsOwner(rg), []string{"10.100.0.0/15"})
+	masterSubnet := newSubnet(tc, vnet, "10.100.76.0/24")


There's a bunch of vnet addressspaces here... how did you pick them all?
If it was from a specific example, maybe include the link in a comment?

I picked them randomly

v2/internal/testcommon/resource_namer.go

matthchr · 2024-08-16T00:05:31Z

v2/internal/testcommon/kube_per_test_context.go

@@ -495,6 +495,33 @@ func (tc *KubePerTestContext) PatchResourceAndWaitForState(
 	tc.Eventually(new).Should(tc.Match.BeInState(status, severity, gen))
 }

+func (tc *KubePerTestContext) CreateSecret(


Wondering if this should be called CreateSimpleSecret, and should have method comments explaining that if data isn't specified it'll be autogenerated?

Though TBH I think you could maybe just drop this bit:

if secretData == "" { secretData = tc.Namer.GeneratePasswordOfLength(40) }

because even with this the usage is

tc.CreateSecret("mysecret", "mykey", "") which I am not sure is clearer than tc.CreateSecret("mysecret", "mykey", tc.GeneratePasswordOfLength(40) and even though the second is a bit longer it's also (IMO) clearer about what's happening compared to the first one.

v2/internal/controllers/crd_redhatopenshift_openshiftcluster_20230401_test.go

super-harsh added 4 commits July 3, 2024 17:53

Add support for ARO clusters

300bb38

Merge branch 'main' into feature/aro-openshift

644c4d5

Mark required properties as secretReference and resourceReference

20b143c

Add recordings and test; Add redact secret logic; update generated files

2650bda

super-harsh requested review from davefellows, theunrepentantgeek, matthchr and babbageclunk as code owners July 8, 2024 06:35

super-harsh added 2 commits July 8, 2024 18:35

Revert

99a809d

update comments

821505a

super-harsh commented Jul 8, 2024

View reviewed changes

v2/internal/testcommon/vcr/redact.go Outdated Show resolved Hide resolved

Update redact secret logic; Make clientID to be imported optionally f…

01664d2

…rom configmap

matthchr reviewed Jul 11, 2024

View reviewed changes

super-harsh added 4 commits July 15, 2024 10:13

Resolve comments

dc9714c

Add new line

ef2e90e

Add makeSecureStringOfLength method

2e77596

update error message

7b7738b

matthchr reviewed Jul 15, 2024

View reviewed changes

super-harsh self-assigned this Aug 9, 2024

super-harsh added 3 commits August 15, 2024 14:48

Merge branch 'main' into feature/aro-openshift

77529c8

Use custom redaction

48ca1af

Merge branch 'main' into feature/aro-openshift

162ea53

matthchr approved these changes Aug 16, 2024

View reviewed changes

matthchr reviewed Aug 16, 2024

View reviewed changes

v2/internal/controllers/crd_redhatopenshift_openshiftcluster_20230401_test.go Outdated Show resolved Hide resolved

super-harsh added 3 commits August 18, 2024 22:26

MArk ProvisioningState as read-only

5799db7

Update test and recording

79ace95

Update deepcopy files

6b6b1d2

super-harsh added this pull request to the merge queue Aug 19, 2024

Merged via the queue into main with commit b91d01b Aug 19, 2024
8 checks passed

super-harsh deleted the feature/aro-openshift branch August 19, 2024 23:48

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for Azure RedhatOpenshift Clusters #4152

Add support for Azure RedhatOpenshift Clusters #4152

super-harsh commented Jul 8, 2024 •

edited

Loading

matthchr commented Jul 11, 2024

matthchr Jul 11, 2024

matthchr Jul 11, 2024

matthchr Jul 11, 2024

matthchr Jul 15, 2024

matthchr Aug 15, 2024

matthchr Aug 15, 2024

matthchr Aug 15, 2024

matthchr Aug 16, 2024

super-harsh Aug 18, 2024

matthchr Aug 16, 2024

matthchr Aug 16, 2024

-// TODO: TO re-record this test, create a new service principal and follow the todos below in the test code.
+// TODO: To re-record this test, create a new service principal and save its details into the
+// TODO: ARO_CLIENT_ID, ARO_CLIENT_SECRET, and ARO_PRINCIPAL_ID variables.
+// TODO: This is required because the ARO resource requires a service principal for input currently. Hopefully
+// TODO: we can revisit this in the future when they support other options.


		clientSecretRef := tc.CreateSecret(secretName, secretKey, details.clientSecret)

		tc.WithLiteralRedaction(details.objectId, "{REDACTED}")

Add support for Azure RedhatOpenshift Clusters #4152

Add support for Azure RedhatOpenshift Clusters #4152

Conversation

super-harsh commented Jul 8, 2024 • edited Loading

matthchr commented Jul 11, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

super-harsh commented Jul 8, 2024 •

edited

Loading