Difference between revisions of "Command Center Installation"
(→Docker Install) |
(→Docker Install) |
||
Line 84: | Line 84: | ||
* [[Ubuntu 20.04]] |
* [[Ubuntu 20.04]] |
||
− | Other versions of Linux may work correctly, but these are the versions that have been verified. |
+ | Other versions of Linux may work correctly, but these are the versions and processes that have been verified. |
== Credentials == |
== Credentials == |
Revision as of 00:42, 21 April 2023
Contents
Pre-Requisites
Before installing or updating Command Center, please verify this section is complete.
The installation and updates of Command Center are done via Docker. Please send support (at) lingoport (dot) com a Docker Hub user so that user can be 'invited' to the Docker Hub repository. Once support receives that email, a reply with a set of files will be sent.
Registering a user on Docker Hub is free. See https://hub.docker.com.
Intro
IT
When installing Command Center on premises, the customer IT group is very important to the successful deployment of the Lingoport applications when installing the suite on site. In particular, the IT group that sets up the Linux system must understand the usage model for the system. Lingoport requires a meeting with the parties responsible for setting up and maintaining the host system before installation can properly begin. The hope is that once the system is setup for installation, minimal IT interaction is necessary.
Preparations must be made with the IT team to ensure that all prerequisites are met before installation. For new installations, this is the recommended method to use to verify that all the various actors work together well.
Basics
Before installing Command Center, the following needs to be configured:
- Hardware
- Linux
- Docker
- Firewall
- Https
Diagram
Hardware & Software Requirements
The following sections describe the hardware and software requirements for Command Center.
Please note that the Globalyzer Server installation is in a different section.
Hardware Requirements
Element | Minimum | Recommended |
---|---|---|
CPU | 2 | 4 |
Memory | 16 GB | 16 GB |
Disk | 160 GB | 500 GB |
The Globalyzer Server may be hosted by Lingoport, reside on another server, or be installed on the same system. Other Linux and Windows machines may have Globalyzer clients installed.
Software requirements
Since this is a Docker installation, most of the containers will be managed by Docker. However, volumes will be mounted on the Linux virtual machine and a database configuration file will reside on the VM: This requires Linux and a Docker installation.
Access and Ports / Firewall
Command Center may need to be accessible by Lingoport and customer personnel to configure jobs, check the console if any problem arise, run jobs if necessary. Command Center needs to be accessible by many customer actors, including development teams, management, and QA, Lingoport, Translation Vendors.
Please see External Access and Ports for all the details.
HTTPS
HTTPS is recommended but not necessary for the Command Center installation. HTTPS may already be set up or your IT may have a standard on how to set up HTTPS. If that's the case, go the next section.
Otherwise, follow this link for a suggested HTTPS configuration:
Docker Install
Docker is a platform that allows you to easily develop, test, and deploy applications as containers. This section will walk you through the process of installing Docker on a Linux system.
The supported versions of Linux are:
- RedHat Enterprise Linux 8
- CentOS 7 (EOL June 2024)
- RedHat Enterprise Linux 7 (EOL June 2024)
- Amazon Linux 2 (EOL June 2025)
- Oracle Linux 8
- Ubuntu 20.04
Other versions of Linux may work correctly, but these are the versions and processes that have been verified.
Credentials
When deploying Command Center, the configuration determines if the user management is done by Command Center itself, via an LDAP, or via SSO (using SAML).
Command Center User Database
One administration user is configured. Contact support (at) lingoport (dot) com in order to get an administration user and password. That user can then create Command Center users. It is strongly recommended to change the first administration password and keep it safe.
LDAP
- LDAP Connection
- Management
SSO
- SSO Connection
- Management
New Command Center Installation
Create the database conf file
Use the default user for Docker which is /home/centos for CentOS systems and /home/ec2-user for RedHat virtual systems. The mysql and conf.d folders may need to be created as well.
cd ~<user> mkdir mysql cd mysql mkdir conf.d cd conf.d vi /home/<user>/mysql/conf.d/mysql.cnf
[client] default-character-set = utf8mb4 [mysql] default-character-set = utf8mb4
Configuration
Request the CommandCenterInstall.zip file from your customer success engineer. The zip file contains four files:
install.conf InstallCommandCenter.sh UninstallCommandCenter.sh UpdateCommandCenter.sh
Copy the above files under your home directory,for instance /home/centos/commandcenterinstall or /home/ec2-user/commandcenterinstall.
Set up install.conf
Fill in your home directory, DB password, serverURL and port number, your Docker Hub username and token. The initial version number will be provided for the first installation. For updates, this will be the only parameter to change in the install.conf
file.
#!/bin/bash # # Provide your home directory, lingoport/commandcenter/Lingoport_Data folder will be created # home_directory=/home/centos # # Provide the MYSQL root password you want to create for the MySQL database container # database_root_password= # # Provide your Docker Hub username # docker_username= # # Provide your Docker Hub account token # docker_account_token= # # The Server URL: '"https://yourserver/command-center"' # serverURL= # # Provide the Command Center server port # serverPort= # # Command Center version # command_center_image_version= # DO NOT CHANGE THE PARAMETERS BELOW # # Provide the Docker network name you want to create # database_network=mysqlnetscommand # # The company name on your Localyzer license # company_name= # lingoport/command-center_dev or lingoport/command-center docker_image=lingoport/command-center
Run InstallCommandCenter.sh
chmod +x InstallCommandCenter.sh sudo ./InstallCommandCenter.sh
To check the running container status
sudo docker ps
If you need to re-run the InstallCommandCenter.sh, make sure to run UninstallCommandCenter.sh first to clean your environment.
Note: Docker image version is not the Command Center version, check latest docker image version at https://hub.docker.com/repository/docker/lingoport/command-center_dev/general
You should see at least an MySQL and a Command Center container running.
Verify Installation
Log in to the URL based on the command-center-config.sh settings, so something like:
https://commandcenter.mycompany.io/
You should now be able to install the licenses and create projects.
The Command Center will initially have one Administrator user CCAdmin with the password please.reset.me.
Command Center Update
Update install.conf
Change the version number in the install.conf to get the Command Center image update version.
command_center_image_version=<new version number>
See full Configuration above.
Run UpdateCommandCenter.sh
chmod +x UpdateCommandCenter.sh sudo ./UpdateCommandCenter.sh
To check the running container status
sudo docker ps
Start and Stop System
- From Command Center, as an administrator, go to settings and click 'Restart'
- From the VM, use docker commands to stop or start Command Center. For example:
sudo docker ps sudo docker stop <hash> sudo docker ps sudo docker container ls -a | grep command sudo docker start <hash> sudo docker ps
Uninstall
sudo ./UninstallCommandCenter.sh Uninstalling the Command Center Servers ...
sudo docker ps CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
FAQ and Troubleshooting
Make sure the Server URL is reachable
Navigate to the server URL set up in install.conf
: is the login screen available?
If it is not, first check that the docker container is up and running. Make sure both lingoport/command-center
and mysql
are running.
sudo docker container ls -a CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES 3d9da7a80e0a lingoport/command-center:80 "catalina.sh run" 3 days ago Up 6 hours 0.0.0.0:8081->8080/tcp, :::8081->8080/tcp pedantic_aryabhata 683c55907c06 mysql:5.7 "docker-entrypoint.s…" 3 days ago Up 6 hours 3306/tcp, 33060/tcp quizzical_newton
Check with IT that the DNS for that system is correct.
Check with IT that the firewall allows for reaching the URL from your system.
Ask IT to check the https and the server URL / DNS.
To check files on disk
To troubleshoot, it may be necessary to check files handled by Docker, such as looking for reports under Lingoport_Data. In that case, first use the Docker PS command to get the container ID of the Command Center application.
sudo docker container ls -a CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES 3d9da7a80e0a lingoport/command-center:80 "catalina.sh run" 3 days ago Up 6 hours 0.0.0.0:8081->8080/tcp, :::8081->8080/tcp pedantic_aryabhata
With the container ID, execute the following command to run bash with access to those files:
sudo docker exec -it 3d9da7a80e0a bash
Next Steps
Command Center is now ready to be used. Proceed to the URL configured in the installation and follow the User's Guide's steps.