Merge pull request #1149 from zgalor/ARO-24796/add-kms-visibility-field

ARO-24796 | feat: add visibility field to AzureKmsEncryption type

Author: zgalor

clientapi/arohcp/v1alpha1/azure_kms_encryption_builder.go

@@ -21,14 +21,15 @@ package v1alpha1 // github.com/openshift-online/ocm-api-model/clientapi/arohcp/v
 
 // Contains the necessary attributes to support KMS encryption for Azure based clusters.
 type AzureKmsEncryptionBuilder struct {
-	fieldSet_ []bool
-	activeKey *AzureKmsKeyBuilder
+	fieldSet_  []bool
+	activeKey  *AzureKmsKeyBuilder
+	visibility AzureKmsEncryptionVisibility
 }
 
 // NewAzureKmsEncryption creates a new builder of 'azure_kms_encryption' objects.
 func NewAzureKmsEncryption() *AzureKmsEncryptionBuilder {
 	return &AzureKmsEncryptionBuilder{
-		fieldSet_: make([]bool, 1),
+		fieldSet_: make([]bool, 2),
 	}
 }
 
@@ -50,7 +51,7 @@ func (b *AzureKmsEncryptionBuilder) Empty() bool {
 // Contains the necessary attributes to support KMS encryption key for Azure based clusters
 func (b *AzureKmsEncryptionBuilder) ActiveKey(value *AzureKmsKeyBuilder) *AzureKmsEncryptionBuilder {
 	if len(b.fieldSet_) == 0 {
-		b.fieldSet_ = make([]bool, 1)
+		b.fieldSet_ = make([]bool, 2)
 	}
 	b.activeKey = value
 	if value != nil {
@@ -61,6 +62,18 @@ func (b *AzureKmsEncryptionBuilder) ActiveKey(value *AzureKmsKeyBuilder) *AzureK
 	return b
 }
 
+// Visibility sets the value of the 'visibility' attribute to the given value.
+//
+// AzureKmsEncryptionVisibility defines the visibility of the Azure KMS key vault.
+func (b *AzureKmsEncryptionBuilder) Visibility(value AzureKmsEncryptionVisibility) *AzureKmsEncryptionBuilder {
+	if len(b.fieldSet_) == 0 {
+		b.fieldSet_ = make([]bool, 2)
+	}
+	b.visibility = value
+	b.fieldSet_[1] = true
+	return b
+}
+
 // Copy copies the attributes of the given object into this builder, discarding any previous values.
 func (b *AzureKmsEncryptionBuilder) Copy(object *AzureKmsEncryption) *AzureKmsEncryptionBuilder {
 	if object == nil {
@@ -75,6 +88,7 @@ func (b *AzureKmsEncryptionBuilder) Copy(object *AzureKmsEncryption) *AzureKmsEn
 	} else {
 		b.activeKey = nil
 	}
+	b.visibility = object.visibility
 	return b
 }
 
@@ -91,5 +105,6 @@ func (b *AzureKmsEncryptionBuilder) Build() (object *AzureKmsEncryption, err err
 			return
 		}
 	}
+	object.visibility = b.visibility
 	return
 }

clientapi/arohcp/v1alpha1/azure_kms_encryption_type.go

@@ -23,8 +23,9 @@ package v1alpha1 // github.com/openshift-online/ocm-api-model/clientapi/arohcp/v
 //
 // Contains the necessary attributes to support KMS encryption for Azure based clusters.
 type AzureKmsEncryption struct {
-	fieldSet_ []bool
-	activeKey *AzureKmsKey
+	fieldSet_  []bool
+	activeKey  *AzureKmsKey
+	visibility AzureKmsEncryptionVisibility
 }
 
 // Empty returns true if the object is empty, i.e. no attribute has a value.
@@ -65,6 +66,33 @@ func (o *AzureKmsEncryption) GetActiveKey() (value *AzureKmsKey, ok bool) {
 	return
 }
 
+// Visibility returns the value of the 'visibility' attribute, or
+// the zero value of the type if the attribute doesn't have a value.
+//
+// visibility defines the visibility of the Azure Key Vault.
+// Accepted values are `public` and `private`.
+// Defaults to `public` if not set.
+func (o *AzureKmsEncryption) Visibility() AzureKmsEncryptionVisibility {
+	if o != nil && len(o.fieldSet_) > 1 && o.fieldSet_[1] {
+		return o.visibility
+	}
+	return AzureKmsEncryptionVisibility("")
+}
+
+// GetVisibility returns the value of the 'visibility' attribute and
+// a flag indicating if the attribute has a value.
+//
+// visibility defines the visibility of the Azure Key Vault.
+// Accepted values are `public` and `private`.
+// Defaults to `public` if not set.
+func (o *AzureKmsEncryption) GetVisibility() (value AzureKmsEncryptionVisibility, ok bool) {
+	ok = o != nil && len(o.fieldSet_) > 1 && o.fieldSet_[1]
+	if ok {
+		value = o.visibility
+	}
+	return
+}
+
 // AzureKmsEncryptionListKind is the name of the type used to represent list of objects of
 // type 'azure_kms_encryption'.
 const AzureKmsEncryptionListKind = "AzureKmsEncryptionList"

clientapi/arohcp/v1alpha1/azure_kms_encryption_type_json.go

@@ -49,6 +49,15 @@ func WriteAzureKmsEncryption(object *AzureKmsEncryption, stream *jsoniter.Stream
 		}
 		stream.WriteObjectField("active_key")
 		WriteAzureKmsKey(object.activeKey, stream)
+		count++
+	}
+	present_ = len(object.fieldSet_) > 1 && object.fieldSet_[1]
+	if present_ {
+		if count > 0 {
+			stream.WriteMore()
+		}
+		stream.WriteObjectField("visibility")
+		stream.WriteString(string(object.visibility))
 	}
 	stream.WriteObjectEnd()
 }
@@ -68,7 +77,7 @@ func UnmarshalAzureKmsEncryption(source interface{}) (object *AzureKmsEncryption
 // ReadAzureKmsEncryption reads a value of the 'azure_kms_encryption' type from the given iterator.
 func ReadAzureKmsEncryption(iterator *jsoniter.Iterator) *AzureKmsEncryption {
 	object := &AzureKmsEncryption{
-		fieldSet_: make([]bool, 1),
+		fieldSet_: make([]bool, 2),
 	}
 	for {
 		field := iterator.ReadObject()
@@ -80,6 +89,11 @@ func ReadAzureKmsEncryption(iterator *jsoniter.Iterator) *AzureKmsEncryption {
 			value := ReadAzureKmsKey(iterator)
 			object.activeKey = value
 			object.fieldSet_[0] = true
+		case "visibility":
+			text := iterator.ReadString()
+			value := AzureKmsEncryptionVisibility(text)
+			object.visibility = value
+			object.fieldSet_[1] = true
 		default:
 			iterator.ReadAny()
 		}

clientapi/arohcp/v1alpha1/azure_kms_encryption_visibility_list_type_json.go

@@ -0,0 +1,76 @@
+/*
+Copyright (c) 2020 Red Hat, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+// IMPORTANT: This file has been generated automatically, refrain from modifying it manually as all
+// your changes will be lost when the file is generated again.
+
+package v1alpha1 // github.com/openshift-online/ocm-api-model/clientapi/arohcp/v1alpha1
+
+import (
+	"io"
+
+	jsoniter "github.com/json-iterator/go"
+	"github.com/openshift-online/ocm-api-model/clientapi/helpers"
+)
+
+// MarshalAzureKmsEncryptionVisibilityList writes a list of values of the 'azure_kms_encryption_visibility' type to
+// the given writer.
+func MarshalAzureKmsEncryptionVisibilityList(list []AzureKmsEncryptionVisibility, writer io.Writer) error {
+	stream := helpers.NewStream(writer)
+	WriteAzureKmsEncryptionVisibilityList(list, stream)
+	err := stream.Flush()
+	if err != nil {
+		return err
+	}
+	return stream.Error
+}
+
+// WriteAzureKmsEncryptionVisibilityList writes a list of value of the 'azure_kms_encryption_visibility' type to
+// the given stream.
+func WriteAzureKmsEncryptionVisibilityList(list []AzureKmsEncryptionVisibility, stream *jsoniter.Stream) {
+	stream.WriteArrayStart()
+	for i, value := range list {
+		if i > 0 {
+			stream.WriteMore()
+		}
+		stream.WriteString(string(value))
+	}
+	stream.WriteArrayEnd()
+}
+
+// UnmarshalAzureKmsEncryptionVisibilityList reads a list of values of the 'azure_kms_encryption_visibility' type
+// from the given source, which can be a slice of bytes, a string or a reader.
+func UnmarshalAzureKmsEncryptionVisibilityList(source interface{}) (items []AzureKmsEncryptionVisibility, err error) {
+	iterator, err := helpers.NewIterator(source)
+	if err != nil {
+		return
+	}
+	items = ReadAzureKmsEncryptionVisibilityList(iterator)
+	err = iterator.Error
+	return
+}
+
+// ReadAzureKmsEncryptionVisibilityList reads list of values of the ”azure_kms_encryption_visibility' type from
+// the given iterator.
+func ReadAzureKmsEncryptionVisibilityList(iterator *jsoniter.Iterator) []AzureKmsEncryptionVisibility {
+	list := []AzureKmsEncryptionVisibility{}
+	for iterator.ReadArray() {
+		text := iterator.ReadString()
+		item := AzureKmsEncryptionVisibility(text)
+		list = append(list, item)
+	}
+	return list
+}

clientapi/arohcp/v1alpha1/azure_kms_encryption_visibility_type.go

@@ -0,0 +1,30 @@
+/*
+Copyright (c) 2020 Red Hat, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+// IMPORTANT: This file has been generated automatically, refrain from modifying it manually as all
+// your changes will be lost when the file is generated again.
+
+package v1alpha1 // github.com/openshift-online/ocm-api-model/clientapi/arohcp/v1alpha1
+
+// AzureKmsEncryptionVisibility represents the values of the 'azure_kms_encryption_visibility' enumerated type.
+type AzureKmsEncryptionVisibility string
+
+const (
+	// The key vault is privately accessible.
+	AzureKmsEncryptionVisibilityPrivate AzureKmsEncryptionVisibility = "private"
+	// The key vault is publicly accessible.
+	AzureKmsEncryptionVisibilityPublic AzureKmsEncryptionVisibility = "public"
+)

model/aro_hcp/v1alpha1/azure_kms_encryption_type.model

@@ -19,4 +19,9 @@ struct AzureKmsEncryption {
 	// The details of the active key
 	// Required during creation.
 	ActiveKey  AzureKmsKey
+
+	// visibility defines the visibility of the Azure Key Vault.
+	// Accepted values are `public` and `private`.
+	// Defaults to `public` if not set.
+	Visibility AzureKmsEncryptionVisibility
 }

model/aro_hcp/v1alpha1/azure_kms_encryption_visibility_type.model

@@ -0,0 +1,24 @@
+/*
+Copyright (c) 2025 Red Hat, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+// AzureKmsEncryptionVisibility defines the visibility of the Azure KMS key vault.
+enum AzureKmsEncryptionVisibility {
+	// The key vault is publicly accessible.
+	Public
+
+	// The key vault is privately accessible.
+	Private
+}

openapi/aro_hcp/v1alpha1/openapi.json

@@ -4143,9 +4143,21 @@
           "active_key": {
             "description": "The details of the active key\nRequired during creation.",
             "$ref": "#/components/schemas/AzureKmsKey"
+          },
+          "visibility": {
+            "description": "visibility defines the visibility of the Azure Key Vault.\nAccepted values are `public` and `private`.\nDefaults to `public` if not set.",
+            "$ref": "#/components/schemas/AzureKmsEncryptionVisibility"
           }
         }
       },
+      "AzureKmsEncryptionVisibility": {
+        "description": "AzureKmsEncryptionVisibility defines the visibility of the Azure KMS key vault.",
+        "type": "string",
+        "enum": [
+          "private",
+          "public"
+        ]
+      },
       "AzureKmsKey": {
         "description": "Contains the necessary attributes to support KMS encryption key for Azure based clusters",
         "properties": {