Setup Provider

Summary: This example demonstrates how to setup and configure a single cloud provider using SkyCluster by defining an XProvider resource. The XProvider is a foundational resource that enables the creation and management of other cloud resources and services within the specified provider.

Once you complete this example, you will have a functional cloud provider setup that can be used to deploy virtual machines, Kubernetes clusters, databases, and other services and you can access to any services inside this provider’s VPC through your local machine.

Before you begin make sure you have followed steps in Getting Started and ensure all prerequisites installed and configured, including:

• Providers Authentication

• Providers Profiles

• SkyCluster Configuration

Initializing Provider

By creating a XProvider resource, SkyCluster creates a virtual private network and a virtual machine with a static IP address that serves as the gateway for all services and resources inside your VPC. It configures routing and sets up overlay networks to provide access to VPC resources. Charges apply as services are provisioned, and when the Provider is deleted, SkyCluster automatically cleans up all associated services.

Before creating a XProvider resource, ensure you have a ProviderProfile instance created and ready for this provider:

kubectl get providerprofile -n skycluster-system
# NAME                  PLATFORM    REGION      READY
# aws-us-east-1         aws         us-east-1   True

Then create a XProvider resource:

AWSGCPOpenStackOn-premises Edge

apiVersion: skycluster.io/v1alpha1
kind: XProvider
metadata:
  name: aws-provider-us-east
spec:

  # Unique identifier for the setup/application
  applicationId: aws-us-east

  # vpcCidr is used region-wide for all services and resources in this VPC
  vpcCidr: 10.16.0.0/16

  # Subnet CIDRs should be within the VPC CIDR range
  subnets:
    - type: public # public | private
      # Public subnets are used for resources that need direct internet access
      # The subnet CIDR range must be within the VPC CIDR range
      # and does not overlap with other subnets and is
      # appropriately sized for the expected number of resources
      cidr: 10.16.0.0/19
      zone: us-east-1a

    - type: private
      cidr: 10.16.32.0/19
      # Some services such as EKS require multiple availability zones
      # so we define a secondary zone here
      zone: us-east-1b

  gateway:
    # Flavor is defined as the number of vCPUs and memory
    flavor: 4vCPU-16GB
    volumeType: gp2
    volumeSize: 20

  providerRef:
    # ProviderRef is a reference to the ProviderProfile instance
    # Where it identifies a single provider by its platform and region
    platform: aws
    region: us-east-1
    zones:
      # The provider is identified by the primary zone
      # Secondary zones are used for high availability or services
      # that require multiple availability zones such as EKS
      primary: us-east-1a
      secondary: us-east-1b

Note

You can determine the appropriate CIDR size for your provider by using the skycluster CLI commands and provide the VPC CIDR. For example, for the VPC CIDR of 10.16.0.0/16:

skycluster subnet 10.16.0.0/16 -p aws
#     NAME                             CIDR
# └── VPC                          10.16.0.0/16
#     ├── Subnet Range             10.16.0.0/17
#     └── XKube Pod Range (EKS)    10.16.128.0/17
#         ├── Primary              10.16.128.0/18
#         └── Secondary            10.16.192.0/18
# └── XKube Service Range (EKS)    172.16.0.0/16

skycluster subnet 10.17.0.0/16 -p gcp
#     NAME                              CIDR
# └── VPC                           10.17.0.0/16
#     ├── Subnet Range              10.17.0.0/17
#     └── XKube Node Range (GKE)    10.17.128.0/17
# └── Pod/Service Range             172.17.0.0/16

The above example creates multiple resources in your project, including a VPC, subnets, security groups, and IAM roles. Once the XProvider resource becomes ready, the region us-east-1 is ready for deploying other resources such as virtual machines, Kubernetes clusters, databases, or other services.

Note

Check the status of the XProvider instance by running the following command or through SkyCluster Dashboard.

kubectl get xproviders.skycluster.io
# NAME                      SYNC     STATUS
# aws-provider-us-east      Ready    Ready

You can also use the SkyCluster cli commadnd:

skycluster xprovider list
# NAME                  PRIVATE_IP      PUBLIC_IP        CIDR_BLOCK
# os-provider-scinet    10.16.128.11    142.1.174.185    10.16.0.0/16

Note

• For on-premises edge providers, ensure that the gateway device is reachable from your local machine via SSH using the private key specified in the secret.

• The gateway and worker nodes are introduced by creating DeviceNode resources. Please refer to Providers Profiles for more details.