Registering a remote physical location with an instance of IBM Software Hub

After you create a remote physical location, you must register the physical location with the instance of IBM Software Hub that you specified when you created the remote physical location.

Who needs to complete this task?: Cluster administrator A cluster administrator must complete this task.

Important: In addition, you must have the Manage physical location (manage_locations) permission on the instance of IBM Software Hub that you want to connect to from the remote physical location.
When do you need to complete this task?: Repeat as needed You must complete this task for each physical location that you want to register with an instance of IBM Software Hub

Important: A physical location can be registered with exactly one primary instance of IBM Software Hub (also called the hub)

Before you begin

Best practice: You can run the commands in this task exactly as written if you use set up environment variables for the remote physical location in addition to the installation environment variables script. For instructions, see Setting up environment variables for a remote physical location.

Before you run the commands in this task, ensure that you source the environment variables for:

The primary cluster
The remote physical location

Before you complete this task, ensure that you completed Creating a remote physical location by installing the IBM Software Hub agents.

About this task

Run the register-physical-location command to give the primary instance of IBM Software Hub (also called the hub) information about the remote physical location and establish mutual trust between the primary instance and the remote physical location.

Procedure

Log the cpd-cli in to the Red Hat® OpenShift® Container Platform cluster:
```
${REMOTE_CPDM_OC_LOGIN}
```
Remember: REMOTE_CPDM_OC_LOGIN is an alias for the cpd-cli manage login-to-ocp command when you are connecting to a remote cluster.
Register the physical location with the hub.
At a minimum, you must specify the following information to register the physical location:
```
cpd-cli manage register-physical-location \
--physical_location_name=${REMOTE_PHYSICAL_LOCATION_ID} \
--display_name=${REMOTE_PHYSICAL_LOCATION_DISPLAY_NAME} \
--cpd_hub_url=${CPD_HUB_URL} \
--cpd_hub_api_key=${CPD_HUB_API_KEY}
```
However you can specify additional parameters to:
- Provide a meaningful description for the physical location.
  Add the following line to your command:
```
--description=${REMOTE_PHYSICAL_LOCATION_DESCRIPTION}
```
- Specify the region where the physical location exists.
  Add the following line to your command:
```
--region=${REMOTE_PHYSICAL_LOCATION_REGION}
```
- Enable the scheduling service to schedule workloads on the physical location.
  By default, the physical location is not enabled, so the scheduling service cannot schedule workloads on it.
  
  Add the following line to your command:
```
--enabled=true
```
  Tip: You can also enable the physical location from the IBM Software Hub web client.
- Specify the priority that the scheduling service should assign to the physical location.
  By default, a physical location has high priority. You can use this option to give the physical location a lower priority. For example, you can use this option to prioritize on-premises physical locations (high) over public cloud physical locations (low) to allow cloud bursting only when on-premises physical locations are at capacity.
  
  Add the following line to your command:
```
--priority=low
```
- Increase the maximum vCPU that the scheduling service can use on the physical location.
  By default, the scheduling service uses the current available vCPU on the cluster to determine whether a workload can be scheduled on the physical location. However, if the remote cluster has a cluster autoscaler, you can specify the maximum amount of vCPU that the scheduling service can use, if the workload exceeds the current available vCPU.
  
  Add the following line to your command:
```
--max_cpu=${REMOTE_PHYSICAL_LOCATION_MAX_CPU}
```
- Increase the maximum ARM-based vCPU that the scheduling service can use on the physical location.
  By default, the scheduling service uses the current available ARM-based vCPU on the cluster to determine whether a workload can be scheduled on the physical location. However, if the remote cluster has a cluster autoscaler, you can specify the maximum amount of ARM vCPU that the scheduling service can use, if the workload exceeds the current available ARM vCPU.
  
  Add the following line to your command:
```
--max_cpu_arm=${REMOTE_PHYSICAL_LOCATION_MAX_CPU_ARM}
```
- Increase the maximum memory that the scheduling service can use on the physical location.
  By default, the scheduling service uses the current available memory on the cluster to determine whether a workload can be scheduled on the physical location. However, if the remote cluster has a cluster autoscaler, you can specify the maximum amount of memory that the scheduling service can use, if the workload exceeds the current available memory.
```
--max_memory=${REMOTE_PHYSICAL_LOCATION_MAX_MEMORY}
```
- Increase the maximum GPU that the scheduling service can use on the physical location.
  By default, the scheduling service uses the current available GPU on the cluster to determine whether a workload can be scheduled on the physical location. However, if the remote cluster has a cluster autoscaler, you can specify the maximum amount of GPU that the scheduling service can use, if the workload exceeds the current available GPU.
```
--max_gpu=${REMOTE_PHYSICAL_LOCATION_MAX_GPU}
```
- Increase the maximum ARM-based GPU that the scheduling service can use on the physical location.
  By default, the scheduling service uses the current available ARM-based GPU on the cluster to determine whether a workload can be scheduled on the physical location. However, if the remote cluster has a cluster autoscaler, you can specify the maximum amount of ARM GPU that the scheduling service can use, if the workload exceeds the current available ARM GPU.
```
--max_gpu_arm=${REMOTE_PHYSICAL_LOCATION_MAX_GPU_ARM}
```

What to do next

Now that you've registered the physical location, you're ready to complete Creating data planes to organize remote physical locations.