Registering a
You must register your TIBCO® Control Plane capabilities. Use the following steps to register your single micro-kubernetes cluster on the .
before you start using the different- You must have Data Plane Manager permission. For more information, see Permission.
- If you have not already set up a Kubernetes cluster, see Setting up a Control Tower Data Plane.
- If you want to configure custom Helm repository, ensure that the latest Helm charts from TIBCO GitHub repository are available in your custom repository.
- Procedure
- In TIBCO Control Plane, click the Data Planes menu on the sidebar.
- Click Register a Data Plane.
- On the card, click Start.
-
On the Data Plane Details screen, specify the Data Plane Name, Description, and Machine Host Name. Here, Machine Host Name is the Fully Qualified Domain Name (FQDN) of the host machine that is running the Control Tower.
-
You must select the EUA checkbox before proceeding.
-
Choose one of the following options to proceed:
-
Register Basic Control Tower: Register the data plane quickly with all default configuration.
-
Proceed with Advanced Configuration: Register the data plane by reviewing or editing all configuration options.
-
Registering Basic Control Tower
- Procedure
- To view default configuration, click the View Configuration Details link.
- Click Register Basic Control Tower.
-
On the Register Data Plane page, you can either download a zip file or display details and registration commands. The zip file contains a script which you can run to register a data plane. Alternatively, you can copy and run the commands displayed on the screen in the same order specified.
- If you choose the download zip file option, extract the downloaded zip file. The zip file contains two files:
dpinstall.sh
anddpregister.env
. -
Run the dpinstall script:
./dpinstall.sh
-
To register a data plane, enter option number 3 in the CLI.
Alternatively, you can run the dpinstall script in silent mode by specifying available arguments. To view available command arguments, run the following command:
./dpinstall.sh --help
-
If you have not already installed NGINX ingress controller, you can install it by entering "yes" when prompted in the CLI.
Note: The ingress class name must match with the already installed NGINX ingress controller. If the ingress class name is different on the Microk8s cluster, re-install the NGINX by entering "yes" when prompted in the CLI.
After the script has ran successfully, the data plane is registered in TIBCO Control Plane. You can verify from the Data Planes page in TIBCO Control Plane UI.
Registering
with Advanced Configuration- Procedure
- On the Namespace & Service account page, specify the following details.
-
On the Resources page, specify the following details:
Storage Class: The host storage class provides persistence for TIBCO services running inside the .
Field Description Resource Name The name of the resource. Description The description of the resource. Storage Class Name The name of the storage class that you want to use to provision file storage. Ingress Controller: An Ingress Controller acts as a reverse proxy and load balancer. It implements a Kubernetes to route and accept requests to send data or notifications from outside the Kubernetes system and load balancing to the TIBCO services running inside.
Field Description Resource Name The name of the resource. FQDN Fully qualified domain name (FQDN) configured for Ingress Controller.
Note: You must use a unique FQDN and path prefix combination within a single cluster for the same Ingress Controller resource.Ingress Class Name The Ingress class name used in the Ingress specification.
Example: nginx
Ingress Controller Specify the type of ingress controller.
Click Next. For more information, see Workshop link, which guides you through the installation of an Ingress Controller preparing for the provisioning of the .
-
On the Configuration page, enter the following configurations.
Field Description Proxy You can use a proxy server to route your outbound and inbound requests through the proxy server. By default, the proxy configuration is disabled. HTTP Proxy A proxy URL to use for creating HTTP connections outside the data plane.
The format for the HTTP proxy is:
http://http_proxy:port/
Example:
http://proxy.example.com:8080/
HTTPS Proxy A proxy URL to use for creating HTTPS connections outside the data plane.
The format for the HTTPS proxy is:
https://https_proxy:port/
Example:
http://proxy.example.com:8084/
No Proxy NO_PROXY value defines a list of destination URLs to exclude from using the proxy.
The format of NO_PROXY is:
https://no_proxy1:port/, https://no_proxy2:port/
Container Registry By default, uses JFrog registry for all component Docker images. Registry URL Username to access the container registry. Repository Password to access the container registry. Helm Chart Repository Global Repository The default Helm chart repository configured at the global level is used by default for the data plane. Custom Helm Chart Repository To configure a new Helm chart repository at the data plane level, click Add Helm Chart Repository to this data plane. Specify the details for the repository. For more information of the fields, see Configuring a Custom Helm Chart Repository. Link other/alternative Global Repository To use a different Helm chart repository than the default one, click Link other / alternative Global Repository. Select the repository from the list. Custom Certificate (Optional) You can use a custom certificate to secure the communication between TIBCO Control Plane and your data plane by providing a Kubernetes secret containing this custom certificate. For more information about how to generate and use the custom certificate, see Using Custom Certificate.
This feature is applicable to self-hosted TIBCO Control Plane only. Custom certificate can be configured for new data planes created starting from TIBCO Control Plane 1.4.0.
Custom Certificate Secret Name Specify the custom certificate secret name. - Preview the configuration.
-
On the Register a Data Plane page, the helm commands for Helm repository configuration, namespace creation, service account creation, and cluster registration are provided. Run the helm commands in your single micro-Kubernetes cluster in the sequence specified on the screen. It is mandatory to run all four commands whether you have an existing namespace and service account or you want to create a one. Cluster Registration command deploys TIBCO Control Plane Infrastructure components in your Kubernetes cluster, which is required to manage and monitor the data plane by using TIBCO Control Plane. Alternatively, you can download a zip file which contains a script to run all these commands.
Note: The Helm commands are unique for each data plane. Copy or download the commands before clicking Done. After you close this screen, you cannot access the Helm commands, and you need to follow the previous steps again.
Field | Description |
---|---|
Namespace | Namespace in which you want to deploy infrastructure components and capabilities. If the namespace is not already created, you can create it by running the command on the last screen of the wizard. |
Service Account | Specify the Kubernetes Service account name. The service account is used when deploying infrastructure components and capabilities. If the service account is not already created, you can create it by running the command on the last screen of the wizard. |
Enable or disable the cluster scope permissions for RBAC | By default, the service account has cluster-scope permissions. If you do not want service account to have cluster-scope permissions, disable the Allow cluster scope permissions option. If cluster-scoped permissions are disabled, cluster-scoped RoleBindings are not created. It creates namespace scoped Role and RoleBindings, which only apply to resources in every namespace. For more information, see Data Plane RBACs. |