Skip to content

Commit 78b9d0e

Browse files
Karthik-K-NKarthik-K-N
authored
Added flag to select ProviderID format for Machine (#580)
* Added flag to select ProviderID format for Machine * Added generated files
1 parent bcb0b1e commit 78b9d0e

File tree

9 files changed

+120
-68
lines changed

9 files changed

+120
-68
lines changed

‎api/v1alpha4/zz_generated.conversion.go‎

Lines changed: 2 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎api/v1beta1/ibmpowervsmachine_types.go‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,12 @@ type IBMPowerVSMachineStatus struct {
158158
// Conditions defines current service state of the IBMPowerVSMachine.
159159
// +optional
160160
Conditions clusterv1.Conditions `json:"conditions,omitempty"`
161+
162+
// Region specifies the Power VS Service instance region
163+
Region *string `json:"region,omitempty"`
164+
165+
// Zone specifies the Power VS Service instance zone
166+
Zone *string `json:"zone,omitempty"`
161167
}
162168

163169
//+kubebuilder:object:root=true

‎api/v1beta1/zz_generated.deepcopy.go‎

Lines changed: 10 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎cloud/scope/powervs_machine.go‎

Lines changed: 38 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,9 @@ import (
2323
"strconv"
2424
"strings"
2525

26-
"k8s.io/utils/pointer"
27-
2826
"github.com/go-logr/logr"
2927
"github.com/pkg/errors"
30-
utils "github.com/ppc64le-cloud/powervs-utils"
28+
powerVSUtils "github.com/ppc64le-cloud/powervs-utils"
3129

3230
"github.com/IBM-Cloud/power-go-client/ibmpisession"
3331
"github.com/IBM-Cloud/power-go-client/power/client/p_cloud_p_vm_instances"
@@ -38,6 +36,8 @@ import (
3836
corev1 "k8s.io/api/core/v1"
3937
"k8s.io/apimachinery/pkg/types"
4038
"k8s.io/klog/v2/klogr"
39+
"k8s.io/utils/pointer"
40+
"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/options"
4141
clusterv1 "sigs.k8s.io/cluster-api/api/v1beta1"
4242
"sigs.k8s.io/cluster-api/util/patch"
4343
"sigs.k8s.io/controller-runtime/pkg/client"
@@ -144,11 +144,13 @@ func NewPowerVSMachineScope(params PowerVSMachineScopeParams) (scope *PowerVSMac
144144
return
145145
}
146146

147-
region, err := utils.GetRegion(*res.RegionID)
147+
region, err := powerVSUtils.GetRegion(*res.RegionID)
148148
if err != nil {
149149
err = errors.Wrap(err, "failed to get region")
150150
return
151151
}
152+
scope.SetRegion(region)
153+
scope.SetZone(*res.RegionID)
152154

153155
options := powervs.ServiceOptions{
154156
IBMPIOptions: &ibmpisession.IBMPIOptions{
@@ -397,6 +399,36 @@ func (m *PowerVSMachineScope) GetInstanceState() v1beta1.PowerVSInstanceState {
397399
return m.IBMPowerVSMachine.Status.InstanceState
398400
}
399401

400-
func (m *PowerVSMachineScope) SetProviderID() {
401-
m.IBMPowerVSMachine.Spec.ProviderID = pointer.StringPtr(fmt.Sprintf("ibmpowervs://%s/%s", m.Machine.Spec.ClusterName, m.IBMPowerVSMachine.Name))
402+
func (m *PowerVSMachineScope) SetRegion(region string) {
403+
m.IBMPowerVSMachine.Status.Region = &region
404+
}
405+
406+
func (m *PowerVSMachineScope) GetRegion() string {
407+
if m.IBMPowerVSMachine.Status.Region == nil {
408+
return ""
409+
}
410+
return *m.IBMPowerVSMachine.Status.Region
411+
}
412+
413+
func (m *PowerVSMachineScope) SetZone(zone string) {
414+
m.IBMPowerVSMachine.Status.Zone = &zone
415+
}
416+
417+
func (m *PowerVSMachineScope) GetZone() string {
418+
if m.IBMPowerVSMachine.Status.Zone == nil {
419+
return ""
420+
}
421+
return *m.IBMPowerVSMachine.Status.Zone
422+
}
423+
424+
// SetProviderID will set the provider id for the machine
425+
func (m *PowerVSMachineScope) SetProviderID(id *string) {
426+
// Based on the ProviderIDFormat version the providerID format will be decided
427+
if options.PowerVSProviderIDFormat == options.PowerVSProviderIDFormatV2 {
428+
if id != nil {
429+
m.IBMPowerVSMachine.Spec.ProviderID = pointer.StringPtr(fmt.Sprintf("ibmpowervs://%s/%s/%s/%s", m.GetRegion(), m.GetZone(), m.IBMPowerVSMachine.Spec.ServiceInstanceID, *id))
430+
}
431+
} else {
432+
m.IBMPowerVSMachine.Spec.ProviderID = pointer.StringPtr(fmt.Sprintf("ibmpowervs://%s/%s", m.Machine.Spec.ClusterName, m.IBMPowerVSMachine.Name))
433+
}
402434
}

‎config/crd/bases/infrastructure.cluster.x-k8s.io_ibmpowervsmachines.yaml‎

Lines changed: 8 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -205,37 +205,9 @@ spec:
205205
resource that holds the details for provisioning the Image for a
206206
Cluster.
207207
properties:
208-
apiVersion:
209-
description: API version of the referent.
210-
type: string
211-
fieldPath:
212-
description: 'If referring to a piece of an object instead of
213-
an entire object, this string should contain a valid JSON/Go
214-
field access statement, such as desiredState.manifest.containers[2].
215-
For example, if the object reference is to a container within
216-
a pod, this would take on a value like: "spec.containers{name}"
217-
(where "name" refers to the name of the container that triggered
218-
the event) or if no container name is specified "spec.containers[2]"
219-
(container with index 2 in this pod). This syntax is chosen
220-
only to have some well-defined way of referencing a part of
221-
an object. TODO: this design is not final and this field is
222-
subject to change in the future.'
223-
type: string
224-
kind:
225-
description: 'Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
226-
type: string
227208
name:
228-
description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
229-
type: string
230-
namespace:
231-
description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
232-
type: string
233-
resourceVersion:
234-
description: 'Specific resourceVersion to which this reference
235-
is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency'
236-
type: string
237-
uid:
238-
description: 'UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids'
209+
description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
210+
TODO: Add other useful fields. apiVersion, kind, uid?'
239211
type: string
240212
type: object
241213
memory:
@@ -390,6 +362,12 @@ spec:
390362
ready:
391363
description: Ready is true when the provider resource is ready.
392364
type: boolean
365+
region:
366+
description: Region specifies the Power VS Service instance region
367+
type: string
368+
zone:
369+
description: Zone specifies the Power VS Service instance zone
370+
type: string
393371
type: object
394372
type: object
395373
served: true

‎config/crd/bases/infrastructure.cluster.x-k8s.io_ibmpowervsmachinetemplates.yaml‎

Lines changed: 2 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -162,38 +162,9 @@ spec:
162162
resource that holds the details for provisioning the Image
163163
for a Cluster.
164164
properties:
165-
apiVersion:
166-
description: API version of the referent.
167-
type: string
168-
fieldPath:
169-
description: 'If referring to a piece of an object instead
170-
of an entire object, this string should contain a valid
171-
JSON/Go field access statement, such as desiredState.manifest.containers[2].
172-
For example, if the object reference is to a container
173-
within a pod, this would take on a value like: "spec.containers{name}"
174-
(where "name" refers to the name of the container that
175-
triggered the event) or if no container name is specified
176-
"spec.containers[2]" (container with index 2 in this
177-
pod). This syntax is chosen only to have some well-defined
178-
way of referencing a part of an object. TODO: this design
179-
is not final and this field is subject to change in
180-
the future.'
181-
type: string
182-
kind:
183-
description: 'Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
184-
type: string
185165
name:
186-
description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
187-
type: string
188-
namespace:
189-
description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
190-
type: string
191-
resourceVersion:
192-
description: 'Specific resourceVersion to which this reference
193-
is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency'
194-
type: string
195-
uid:
196-
description: 'UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids'
166+
description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
167+
TODO: Add other useful fields. apiVersion, kind, uid?'
197168
type: string
198169
type: object
199170
memory:

‎controllers/ibmpowervsmachine_controller.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -205,6 +205,7 @@ func (r *IBMPowerVSMachineReconciler) reconcileNormal(ctx context.Context, machi
205205
if err != nil {
206206
return ctrl.Result{}, err
207207
}
208+
machineScope.SetProviderID(instance.PvmInstanceID)
208209
machineScope.SetInstanceID(instance.PvmInstanceID)
209210
machineScope.SetAddresses(instance)
210211
machineScope.SetHealth(instance.Health)
@@ -227,7 +228,6 @@ func (r *IBMPowerVSMachineReconciler) reconcileNormal(ctx context.Context, machi
227228
}
228229
machineScope.Info(*ins.PvmInstanceID)
229230
}
230-
machineScope.SetProviderID()
231231

232232
// Requeue after 2 minute if machine is not ready to update status of the machine properly
233233
if !machineScope.IsReady() {

‎main.go‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ package main
1818

1919
import (
2020
"flag"
21+
"fmt"
2122
"os"
2223
"time"
2324

@@ -35,6 +36,7 @@ import (
3536
infrastructurev1alpha4 "sigs.k8s.io/cluster-api-provider-ibmcloud/api/v1alpha4"
3637
infrastructurev1beta1 "sigs.k8s.io/cluster-api-provider-ibmcloud/api/v1beta1"
3738
"sigs.k8s.io/cluster-api-provider-ibmcloud/controllers"
39+
"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/options"
3840
// +kubebuilder:scaffold:imports
3941
)
4042

@@ -68,6 +70,11 @@ func main() {
6870

6971
ctrl.SetLogger(klogr.New())
7072

73+
if err := validateFlags(); err != nil {
74+
setupLog.Error(err, "Flag validation failure")
75+
os.Exit(1)
76+
}
77+
7178
if watchNamespace != "" {
7279
setupLog.Info("Watching cluster-api objects only in namespace for reconciliation", "namespace", watchNamespace)
7380
}
@@ -210,4 +217,24 @@ func initFlags(fs *pflag.FlagSet) {
210217
10*time.Minute,
211218
"The minimum interval at which watched resources are reconciled.",
212219
)
220+
221+
fs.StringVar(
222+
&options.PowerVSProviderIDFormat,
223+
"powervs-provider-id-fmt",
224+
options.PowerVSProviderIDFormatV1,
225+
"ProviderID format is used set the Provider ID format for Machine",
226+
)
227+
}
228+
229+
func validateFlags() error {
230+
switch options.PowerVSProviderIDFormat {
231+
case options.PowerVSProviderIDFormatV1:
232+
setupLog.Info("Using v1 version of ProviderID format")
233+
case options.PowerVSProviderIDFormatV2:
234+
setupLog.Info("Using v2 version of ProviderID format")
235+
default:
236+
errStr := fmt.Errorf("Invalid value for flag powervs-provider-id-fmt: %s, Supported values: v1, v2 ", options.PowerVSProviderIDFormat)
237+
return errStr
238+
}
239+
return nil
213240
}

‎pkg/options/options.go‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
/*
2+
Copyright 2022 The Kubernetes Authors.
3+
4+
Licensed under the Apache License, Version 2.0 (the "License");
5+
you may not use this file except in compliance with the License.
6+
You may obtain a copy of the License at
7+
8+
http://www.apache.org/licenses/LICENSE-2.0
9+
10+
Unless required by applicable law or agreed to in writing, software
11+
distributed under the License is distributed on an "AS IS" BASIS,
12+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
See the License for the specific language governing permissions and
14+
limitations under the License.
15+
*/
16+
17+
package options
18+
19+
// PowerVSProviderIDFormat is used to identify the Provider ID format for Machine
20+
var PowerVSProviderIDFormat string
21+
22+
// PowerVSProviderIDFormatV2 will set provider id to machine as ibmpowervs://<region>/<zone>/<service_instance_id>/<powervs_machine_id>
23+
const PowerVSProviderIDFormatV2 = "v2"
24+
25+
// PowerVSProviderIDFormatV1 will set provider id to machine as ibmpowervs://<cluster_name>/<vm_hostname>
26+
const PowerVSProviderIDFormatV1 = "v1"

0 commit comments

Comments
 (0)