Home
HCL Sametime® Administration Guide 12.0.1
Installing
This section provides information on installing the servers for Sametime and Sametime Premium.
Installing Sametime
You can install HCL Sametime Premium and HCL Sametime in a single- or multi-node container environment. Four platforms are supported: Docker, Podman, Kubernetes, and OpenShift.
Installing Sametime in a Kubernetes environment
A Sametime deployment on Kubernetes requires a properly configured cluster consisting of a minimum of four nodes: a control plane and three worker nodes with an Ingress Controller.
Installing Ingress
When running Kubernetes on-prem, managing load-balancing must be considered for Sametime Meetings and Web Chat. Both of these Sametime features require the addition of an ingress controller.

HCL Sametime® Administration Guide 12.0.1
- Accessibility features for Sametime
  Accessibility features help users who have a disability, such as restricted mobility or limited vision, use information technology products successfully. HCL® strives to provide products with usable access for everyone.
- What's new
  HCL Sametime and HCL Sametime Premium 12.0.1 provide many new features, enhancements and fixes to servers and clients. Additional releases to version 12.0.1 also provides updates to the product.
- Planning
  This section describes the system requirements and server configurations needed for HCL Sametime and HCL Sametime Premium.
- Installing
  This section provides information on installing the servers for Sametime and Sametime Premium.
  - Installation road map
    The installation road map lists the high-level steps for installing your product. Reviewing the high-level steps before you start the installation process helps you be prepared when prompted for information during the installation.
  - Installing MongoDB
    The MongoDB Community Server can be downloaded from the MongoDB website. You can install MongoDB on Windows and Linux platforms. For information on MongoDB about its purpose for Sametime and deployment options, see mongodb.html.
  - Installing Sametime
    You can install HCL Sametime Premium and HCL Sametime in a single- or multi-node container environment. Four platforms are supported: Docker, Podman, Kubernetes, and OpenShift.
    - Information to provide during installation
      During the install process, you are prompted for information used to tailor the installation for your environment.
    - Installing Sametime in a Kubernetes environment
      A Sametime deployment on Kubernetes requires a properly configured cluster consisting of a minimum of four nodes: a control plane and three worker nodes with an Ingress Controller.
      - Preparing to install an Openshift environment
        You must complete the tasks in this topic if you are installing in an Openshift environment before you can install Sametime.
      - Preparing the network
        This section provides information on the network considerations needed to install Kubernetes.
      - Loading the Sametime image to Docker
        This section provides information on the network considerations needed to install Kubernetes.
      - Preparing the deployment
        This section provides information on how to configure secrets for deployment.
      - Creating the persistent volume
        This section provides information to create the persistent volume.
      - Deploying Sametime to Kubernetes cluster
        Before you can deploy Sametime to a Kubernetes cluster, you must create the cluster.
      - Installing Ingress
        When running Kubernetes on-prem, managing load-balancing must be considered for Sametime Meetings and Web Chat. Both of these Sametime features require the addition of an ingress controller.
        Configuring Ingress for Mux
      - Installing Prometheus
        Prometheus provides monitoring on the system. It is used in the auto-scaling feature, but can also be used to monitor your system usage and performance.
      - Installing Sametime with multiple video bridges
        This section covers the steps on how to enable multiple video bridges. Below is a list of several secrets defined in the sametime-global-secrets resource. There are others not mentioned here as well. Refer to managing_secrets_kubernetes.html for the basic guidelines regarding post-installation configuration.
    - Installing Sametime in a Docker or Podman environment
      The process to install Sametime on Docker and Podman are identical. The installation process detects if you are installing Sametime on Docker or Podman and prompts for the appropriate information.
  - Installing Sametime clients
    Sametime clients can be installed on a Windows or Mac machines.
- Configuring
  This section provides information on configuring the HCL Sametime server. Configuration tasks are dependent on the deployment environment.
- Securing
  This section provides information on securing your HCL Sametime environments.
- Administering
  This section provides information on administering on Sametime environments.
- Troubleshooting
  This section provides information on troubleshooting and supporting Sametime environments.
- Uninstalling Sametime
  In the event that Sametime must be removed, follow the procedure for the platform that Sametime is installed on.
- Migrating and Upgrading
  This section provides information on migrating data from an earlier release to Sametime 12.
- Notices

Installing Ingress

When running Kubernetes on-prem, managing load-balancing must be considered for Sametime Meetings and Web Chat. Both of these Sametime features require the addition of an ingress controller.

Before you begin

Ingress is secured with a TLS certificate which must be created. Create a secret for ingress by following the steps in Updating the TLS certificates on Kubernetes.

If different the host names for Web Chat and Meetings are different, open the values.yaml file and add the following line to identify the Web Chat host name.

extraChatHostname: web_chat_hostname

Verify that there are two spaces at the beginning of the line. Save and close the values.yaml file.

Consider reserving a reserve a static IP address for Sametime to use. If one is not define during the installation, the IP address is dynamic and is subject to change.

About this task

There are many different ingress controllers available, however; not all of them have been tested with Sametime. The procedure in this topic describes deploying the NGINX Ingress controller. If you are using another ingress controller, refer to the documentation for that ingress controller.

An Ingress controller is also used for the Connect and Embedded clients mux traffic deployed on-premise Kubernetes. After installing the ingress controller, additional configuraiton steps are needed. See Configuring Ingress for Mux for details.

Helm commands are used to install and configure the NGINX Ingress controller.

Procedure

Add the nginx repository using the helm repo command.


helm repo add ingress-nginx https://kubernetes.github.io/ingress-nginx

Update the repository with the following command.
```
helm repo update
```
Run the following command to install NGINX.
```
helm install nginx-ingress ingress-nginx/ingress-nginx --set controller.service.loadBalancerIP=IP_address 
```
Where IP_address is the reserved IP address.
If you have a namespace dedicated to Sametime, include the namespace option on the command.
Verify that nginx-ingress has accepted the correct static IP address by running the kubectl get command. To break free from this, use Ctrl+C.
```
kubectl get ingress
```
Use Ctrl+C to return to the command prompt.

Rate this topic

5 stars 4 stars 3 stars 2 stars 1 star

Comment on this topic.

By clicking this box, you acknowledge that you are NOT a U.S. Federal Government employee or agency, nor are you submitting information with respect to or on behalf of one. HCL provides software and services to U.S. Federal Government customers through its partners immixGroup, Inc. Contact this team at https://hcltechsw.com/resources/us-government-contact. Do not include any personal data in this Comment box. Note: To report a problem or question about the product software, do not use this form. Instead, go to the HCL Software Support site.