Install DX Platform
This section provides the following information:
This section provides the following information:
Download the Installer Distribution File
DX Platforminstaller is bundled with the DX APM distribution zip file (DX Application Performance Management - <version>). This distribution file includes the
DX Platformfiles for:
- Online installation:Use this method when the installing host has access to the Internet. In this mode, download the online version of the installer from theCustomer Success Associate (CSA) or Broadcom Support.
- Offline installation:Use this method when the installing host does not have access to the Internet. In this mode, download the offline version of the installer from the
Follow these steps:
- Create a directory namedinstall_directoryon a host that has access to the Kubernetes cluster.
- Log in to thesite using your credentials.Support
- Navigate to theDOWNLOAD MANAGEMENTsection.
- Search forApplication Performance Management.
- In theProduct Downloadssection, select the version.
- ClickDownloadto download the zip file to theinstall_directoryfolder.
- Online Installer:DXCommonPlatformInstaller-<version>-online(About 50 MB)
- Offline Installer:DXCommonPlatformInstaller-<version>-offline(About 20 GB)
- Extract the downloaded zip file.
- Online Installer:DXCommonPlatformInstaller-<version>-online.tar.gz
- Offline Installer:DXCommonPlatformInstaller-<version>-offline.tar.gz
Run the Installer
Before you run the installer, consider the following points:
- If you run the installer on the non-master node, copy the cluster kubeconfig from master to the installation directory.
You can run the installer in one of the following ways:
- Interactive Console Install Mode:In this mode, you must provide the inputs at the prompt for the installation.
- Silent Install Mode:In this mode, theDX Platformis installed using the values mentioned in thedxi.input.vars.ymlfile. This file is available in the root installation folder. To install in silent mode, we recommend running the installer in the Interactive Console Install mode first to generate thedxi.input.vars.ymlfile.
If you are installing the
DX Platformfor the first time, you must run the installer in the
Interactive Console Installmode. Perform the following steps to install the
DX Platformin the Interactive Console Install mode.
Before you install the
DX Platform, you can use the Environment validation flag (
--validate) to verify if the hardware resources (requirements) are available and if the NFS directory is created.
./install.sh -u=<username> -p=<password> --ignore-errors --validate
./install.sh --ignore-errors --validate
--ignore-errorsflag enables the installer to continue with the installation even if the pods do not start in the given time frame.
Follow these steps:
- Navigate to the install directory.cd <install directory>
- Initiate the installer:
The --ignore-errors flag enables the installer to continue with the installation even if the pods do not start in the given time frame.Additional flags supported by the installer:
- Online Install:If you use this option, the installer pulls the images from the Bintray repository. For the online installation credentials, contact yourCustomer Support Associate (CSA) or Support../install.sh -u=<username> -p=<password> --ignore-errors
- Offline Install:If you use this option, the installer loads images from the local file../install.sh --ignore-errors
- --silent- Use this flag to run the installer in the Silent mode. The Silent mode requires thedxi.input.vars.ymlfile to be located in the installer directory with the necessary values. To install in theSilent mode, we recommend running the installer in theInteractive Console Installmode first to generate thedxi.input.vars.ymlfile.
- --skip-ssl- Use this flag to skip validating the self signed certificates for HTTPS communication.
- --skip-checks- Use this flag to skip all the user input validations. We do not recommend using this flag.
- Provide the required information at the prompt:
On successful installation, the installer displays the confirmation message and the URL (http://apmservices-gateway.<domain>/dxiportal) to log in to the Cluster Management console (DX Platform).Verify the InstallationAfter the installation, run the following command to verify the status of the pods. The status must display as Running or Completed (you may have to wait a few minutes).
- Accept the terms of the CA End-User License Agreement:
- Y:Type Y to proceed with the installation.
- N:Type N to quit the installation.
- Installation type:
- 1.Kubernetes:Type 1 for Kubernetes-based installation. In this release, only Kubernetes is supported.
- Registry installation:
- 1. install:Type 1 to install a registry in the cluster using the installer. If a registry already exists, the installer displays a message to select theuse_existingoption.
- 2. use_existing:Type 2 to provide the URL of your own registry. For more information about setting up the private docker registry, see thesection.Set Up and Configure the Private Docker Registry
- (Conditional) Specify the registry URL:Specify the private docker registry URL of your organization. If this URL requires authorization, then the installer prompts for the username and password.Validation:Installer pushes an image to the registry to validate the access.
- Specify the Kubernetes namespace for installation:Specify the Kubernetes namespace. All the pods are deployed in the namespace you specify here.Validation:The namespace must contain alphanumeric characters in lowercase. The namespace must start and end with an alphanumeric character and can be separated by '-'. For example, 'my-name'.After you specify the namespace, the installer displays the Master IP from the kube config file.
- (Conditional) Choose Kubernetes cluster:This prompt is displayed only if multiple clusters are mentioned in the kube config file. Choose the cluster for the installation.
- (Conditional) Choose Kubernetes user:This prompt is displayed only if multiple users are mentioned in the kube config file. Choose the user for the installation.The installer supports both the following Kubernetes account types:
To use the Kubernetes account, the user should exist in the Kubernetes cluster. This user should have cluster admin privileges to create a namespace and PV. This user should also be mentioned in the kube config file.For example,users:- name: minikubeuser:client-certificate: /root/.minikube/client.crtclient-key: /root/.minikube/client.key- name: someuseruser:password: <password>username: <username>Validation:The installer validates the Nginx Ingress Controller version (0.23.0 or higher). If the version is incorrect, the installer exits.
- Specify the Wildcard DNS:Enter the wildcard DNS of the node running the Ingress Controller or the load balancer.Validation:Installer verifies if this host is reachable by pinging this host.
- Do you want secure routes:
- Y:TypeYto enable the secure route for HTTPS encrypted communication. We recommend using the secure route for every installation.
- (Conditional)Do you want to provide your own SSL certificate and key?Ensure that the generated.crtand.keyfiles are placed in thetls_certsfolder in the installer directory.
- Y:TypeYto provide your own SSL certificate and key files:
- Provide the .crt file name.
- Provide the corresponding .key file name.
- N:TypeNto generate the files using the installer. The installer generates the SSL certificate and the key in thetls_certsfolder under the install directory.
- N:Type N for no encryption using HTTP.
- Specify the name of NFS server IP/host:Type the host name or IP address of the node where the NFS server runs. For more information, see thesection.Configure the NFS Base DirectoryValidation:Installer verifies if the NFS server is reachable.
- Specify the NFS folder:Specify the name of the NFS base directory that you created in the Kubernetes cluster. For example,/nfs/ca/dxiValidation:Installer verifies that all the nodes can read/write to this NFS base folder.
- (Conditional) Specify the installation size:Select the installation size depending on how many nodes are labeled as Elasticsearch nodes. Small installation can be used for demo and Medium installation for standard installation.
- 1. Small Installation: One Elasticsearch Hot node is labeled:Type 1 for small installation.
- 2. Medium Installation: Three Elasticsearch Hot nodes are labeled:Type 2 for medium installation.
- Do you want to enable OI:
Validation:The installer validates the Max Open Files Limit, Max Map Count on all the nodes, and the Elasticsearch prerequisites. The installer also validates the hardware requirements for the installation.
- Y:TypeYto enable DX Operational Intelligence
- N:TypeNto enable DX Operational Intelligence later. You can always enable DX OI later. For more information, see the
- (Optional) Specify the SMTP server details:You can specify the SMTP server details during or after the installation. To skip this step during the installation, press ENTER. Run theupdate-smtp-details.shscript to provide this information post installation.
- Specify the SMTP service URLin the following format:smtp/smtps://<Service_URL>:587Validation:None
- (Conditional)Specify the SMTP account:Specify the username.
- (Conditional)Specify the SMTP credential:Specify the password.Validation:The installer also validates if this SMTP server is reachable from the cluster.
- Enter the password for the master admin:Enter a password for the Master Administrator. This account allows you to create tenants and manage the DX Platform deployment. If the admin password reset fails, the default password (master1234!) is used.Validation:The password must be 6 - 25 characters long. The password must be a combination of all the following characters:
- at least one uppercase character
- at least one lowercase character
- at least one number, and
- at least one special character ((!, @, #, $, %, ^, &, *, _, +))
- Re-Enter the password for the master admin:Re-enter the same password.Validation:The password must match the password that was entered in the previous step.
If some of the pods are not in thekubectl get pods -n <namespace>RunningorCompletedstate even after a couple of minutes, contact the Broadcom support.For initiation logs, you can check the<host>:/nfs/ca/dxi/dxi-platform-init-pod/dxi-platform-init-pod.logfile. This log file lets you know if the master admin has been reset and if the global admin account was created successfully.After you have installed and verified the installation, log in to the Cluster Management console as a Master Administrator.Login to the Cluster ManagementFollow these steps:
section.Post Installation Tasks
- Open the URL that was displayed after the installation:http://apmservices-gateway.<domain>/dxiportal
- Provide the following details:
- Tenant Id: masteradmin
- Username: masteradmin
- Password: The master admin password that you provided during the installation. If the password does not work, trymaster1234!which is the default password. If the password gets locked after several attempts, see thesection.Troubleshooting the Installation