-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add support for clusters in multiple regions
Adding `ClientProvider` allows clusters to use different `OCIClients` groups to interact with the regional APIs.
- Loading branch information
Showing
24 changed files
with
1,404 additions
and
118 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,152 @@ | ||
| /* | ||
| Copyright (c) 2022, Oracle and/or its affiliates. | ||
| 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. | ||
| */ | ||
|
|
||
| package scope | ||
|
|
||
| import ( | ||
| "sync" | ||
|
|
||
| "github.com/go-logr/logr" | ||
| "github.com/oracle/cluster-api-provider-oci/cloud/services/compute" | ||
| "github.com/oracle/cluster-api-provider-oci/cloud/services/vcn" | ||
| "github.com/oracle/oci-go-sdk/v63/common" | ||
| "github.com/oracle/oci-go-sdk/v63/core" | ||
| "github.com/oracle/oci-go-sdk/v63/identity" | ||
| "github.com/oracle/oci-go-sdk/v63/networkloadbalancer" | ||
| "github.com/pkg/errors" | ||
| "k8s.io/klog/v2/klogr" | ||
| ) | ||
|
|
||
| // OCIClients is the struct of all the needed OCI clients | ||
| type OCIClients struct { | ||
| ComputeClient compute.ComputeClient | ||
| VCNClient vcn.Client | ||
| LoadBalancerClient *networkloadbalancer.NetworkLoadBalancerClient | ||
| IdentityClient *identity.IdentityClient | ||
| } | ||
|
|
||
| // ClientProvider defines the regional clients | ||
| type ClientProvider struct { | ||
| *logr.Logger | ||
| ociClients map[string]OCIClients | ||
| ociClientsLock *sync.RWMutex | ||
| ociAuthConfigProvider common.ConfigurationProvider | ||
| } | ||
|
|
||
| // NewClientProvider builds the ClientProvider with a client for the given region | ||
| func NewClientProvider(ociAuthConfigProvider common.ConfigurationProvider) (*ClientProvider, error) { | ||
| log := klogr.New() | ||
|
|
||
| if ociAuthConfigProvider == nil { | ||
| return nil, errors.New("ConfigurationProvider can not be nil") | ||
| } | ||
|
|
||
| provider := ClientProvider{ | ||
| Logger: &log, | ||
| ociAuthConfigProvider: ociAuthConfigProvider, | ||
| ociClients: map[string]OCIClients{}, | ||
| ociClientsLock: new(sync.RWMutex), | ||
| } | ||
|
|
||
| return &provider, nil | ||
| } | ||
|
|
||
| // GetOrBuildClient if the OCIClients exist for the region they are returned, if not clients will build them | ||
| func (c *ClientProvider) GetOrBuildClient(region string) (OCIClients, error) { | ||
| if len(region) <= 0 { | ||
| return OCIClients{}, errors.New("ClientProvider.GetOrBuildClient region can not be empty") | ||
| } | ||
|
|
||
| c.ociClientsLock.RLock() | ||
| clients, regionalClientsExists := c.ociClients[region] | ||
| c.ociClientsLock.RUnlock() | ||
|
|
||
| if regionalClientsExists { | ||
| return clients, nil | ||
| } | ||
|
|
||
| c.ociClientsLock.Lock() | ||
| defer c.ociClientsLock.Unlock() | ||
| regionalClient, err := createClients(region, c.ociAuthConfigProvider, c.Logger) | ||
| if err != nil { | ||
| return regionalClient, err | ||
| } | ||
| c.ociClients[region] = regionalClient | ||
|
|
||
| return regionalClient, nil | ||
| } | ||
|
|
||
| func createClients(region string, oCIAuthConfigProvider common.ConfigurationProvider, logger *logr.Logger) (OCIClients, error) { | ||
| vcnClient, err := createVncClient(region, oCIAuthConfigProvider, logger) | ||
| lbClient, err := createLbClient(region, oCIAuthConfigProvider, logger) | ||
| identityClient, err := createIdentityClient(region, oCIAuthConfigProvider, logger) | ||
| computeClient, err := createComputeClient(region, oCIAuthConfigProvider, logger) | ||
|
|
||
| if err != nil { | ||
| return OCIClients{}, err | ||
| } | ||
|
|
||
| return OCIClients{ | ||
| VCNClient: vcnClient, | ||
| LoadBalancerClient: lbClient, | ||
| IdentityClient: identityClient, | ||
| ComputeClient: computeClient, | ||
| }, err | ||
| } | ||
|
|
||
| func createVncClient(region string, ociAuthConfigProvider common.ConfigurationProvider, logger *logr.Logger) (*core.VirtualNetworkClient, error) { | ||
| vcnClient, err := core.NewVirtualNetworkClientWithConfigurationProvider(ociAuthConfigProvider) | ||
| if err != nil { | ||
| logger.Error(err, "unable to create OCI VCN Client") | ||
| return nil, err | ||
| } | ||
| vcnClient.SetRegion(region) | ||
|
|
||
| return &vcnClient, nil | ||
| } | ||
|
|
||
| func createLbClient(region string, ociAuthConfigProvider common.ConfigurationProvider, logger *logr.Logger) (*networkloadbalancer.NetworkLoadBalancerClient, error) { | ||
| lbClient, err := networkloadbalancer.NewNetworkLoadBalancerClientWithConfigurationProvider(ociAuthConfigProvider) | ||
| if err != nil { | ||
| logger.Error(err, "unable to create OCI LB Client") | ||
| return nil, err | ||
| } | ||
| lbClient.SetRegion(region) | ||
|
|
||
| return &lbClient, nil | ||
| } | ||
|
|
||
| func createIdentityClient(region string, ociAuthConfigProvider common.ConfigurationProvider, logger *logr.Logger) (*identity.IdentityClient, error) { | ||
| identityClient, err := identity.NewIdentityClientWithConfigurationProvider(ociAuthConfigProvider) | ||
| if err != nil { | ||
| logger.Error(err, "unable to create OCI Identity Client") | ||
| return nil, err | ||
| } | ||
| identityClient.SetRegion(region) | ||
|
|
||
| return &identityClient, nil | ||
| } | ||
|
|
||
| func createComputeClient(region string, ociAuthConfigProvider common.ConfigurationProvider, logger *logr.Logger) (*core.ComputeClient, error) { | ||
| computeClient, err := core.NewComputeClientWithConfigurationProvider(ociAuthConfigProvider) | ||
| if err != nil { | ||
| logger.Error(err, "unable to create OCI Compute Client") | ||
| return nil, err | ||
| } | ||
| computeClient.SetRegion(region) | ||
|
|
||
| return &computeClient, nil | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,116 @@ | ||
| /* | ||
| Copyright (c) 2022, Oracle and/or its affiliates. | ||
| 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. | ||
| */ | ||
|
|
||
| package scope | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "crypto/rand" | ||
| "crypto/rsa" | ||
| "crypto/x509" | ||
| "encoding/pem" | ||
| "fmt" | ||
| "sync" | ||
|
|
||
| "github.com/oracle/cluster-api-provider-oci/cloud/config" | ||
| "github.com/oracle/cluster-api-provider-oci/cloud/services/compute" | ||
| "github.com/oracle/cluster-api-provider-oci/cloud/services/vcn" | ||
| "github.com/oracle/oci-go-sdk/v63/identity" | ||
| "github.com/oracle/oci-go-sdk/v63/networkloadbalancer" | ||
| "k8s.io/klog/v2/klogr" | ||
| ) | ||
|
|
||
| type MockOCIClients struct { | ||
| VCNClient vcn.Client | ||
| ComputeClient compute.ComputeClient | ||
| LoadBalancerClient *networkloadbalancer.NetworkLoadBalancerClient | ||
| IdentityClient *identity.IdentityClient | ||
| } | ||
|
|
||
| var ( | ||
| MockTestRegion = "us-lexington-1" | ||
| ) | ||
|
|
||
| func MockNewClientProvider(mockClients MockOCIClients) (*ClientProvider, error) { | ||
|
|
||
| clientsInject := map[string]OCIClients{MockTestRegion: { | ||
| VCNClient: mockClients.VCNClient, | ||
| LoadBalancerClient: mockClients.LoadBalancerClient, | ||
| IdentityClient: mockClients.IdentityClient, | ||
| ComputeClient: mockClients.ComputeClient, | ||
| }} | ||
|
|
||
| authConfig, err := MockAuthConfig() | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| ociAuthConfigProvider, err := config.NewConfigurationProvider(&authConfig) | ||
| if err != nil { | ||
| fmt.Printf("expected ociAuthConfigProvider to be created %s \n", err) | ||
| return nil, err | ||
| } | ||
| log := klogr.New() | ||
| clientProvider := ClientProvider{ | ||
| Logger: &log, | ||
| ociClients: clientsInject, | ||
| ociClientsLock: new(sync.RWMutex), | ||
| ociAuthConfigProvider: ociAuthConfigProvider, | ||
| } | ||
|
|
||
| return &clientProvider, nil | ||
| } | ||
|
|
||
| func MockAuthConfig() (config.AuthConfig, error) { | ||
| privateKey, err := generatePrivateKeyPEM() | ||
| if err != nil { | ||
| fmt.Println("error generating a private key") | ||
| return config.AuthConfig{}, err | ||
| } | ||
|
|
||
| authConfig := config.AuthConfig{ | ||
| UseInstancePrincipals: false, | ||
| Region: MockTestRegion, | ||
| Fingerprint: "mock-finger-print", | ||
| PrivateKey: privateKey, | ||
| UserID: "ocid1.tenancy.oc1..<unique_ID>", | ||
| TenancyID: "ocid1.tenancy.oc1..<unique_ID>", | ||
| } | ||
|
|
||
| return authConfig, nil | ||
| } | ||
|
|
||
| func generatePrivateKeyPEM() (string, error) { | ||
| privateKey, err := rsa.GenerateKey(rand.Reader, 1024) | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
|
|
||
| privateKeyBytes := x509.MarshalPKCS1PrivateKey(privateKey) | ||
| privateKeyBlock := &pem.Block{ | ||
| Type: "RSA PRIVATE KEY", | ||
| Bytes: privateKeyBytes, | ||
| } | ||
|
|
||
| var privateKeyBuf bytes.Buffer | ||
| err = pem.Encode(&privateKeyBuf, privateKeyBlock) | ||
| if err != nil { | ||
| fmt.Printf("error when encode private pem: %s \n", err) | ||
| return "", err | ||
| } | ||
|
|
||
| return privateKeyBuf.String(), err | ||
| } |
Oops, something went wrong.