MyST Installation Guide
- Understanding the MyST installation
- MyST Topology
- Alternative MyST Topologies
- System Requirements
- Network Requirements
- Installation in 3 simple steps
Understanding the MyST installation
A typical MyST installation consists of the following:
Component | Purpose |
---|---|
MyST Studio | Web-based Management Console |
MyST Repository | Storage layer for MyST platform and application state |
MyST Build Server | Optional CI Server, if not using a third-party one such as Jenkins |
MyST Maven Repository | Optional Maven Repository, if not using a third-party one such as Artifactory |
The MyST Studio console can be installed on a single server or across multiple tiers. MyST is supported on a container-based architecture (e.g. docker
) or on a virtual/physical server architecture. Rubicon Red recommend the use of the container-based architecture.
MyST Topology
The MyST Server can be established on modern container runtimes such as docker
(CE / EE) and containerd
. An installer is provided to easily establish the stack on a single server instance. After completing the installation and starting the containers, the following containers will be running:
myststudio_https
- Nginx exposing443
and80
myststudio_web
- Tomcat instance accessed bymyststudio_https
myststudio_db
- MySQL instance accessed bymyststudio_web
State for the stack is automatically stored in a container volume and accessed via myststudio_db
.
The following additional containers can be optionally installed:
myststudio_ci
- MyST Build Server exposing8081
by defaultmaven-repository
- MyST Maven Repository exposing8083
by default
Exposed ports can be configured by adjusting the port mappings in the docker-compose
/ docker stack
configuration
Alternative MyST Topologies
In an event that container-based topology is undesired, the stack can be rolled out on a non-container infrastructure. More details on this approach are documented in the Alternative Installations section.
System Requirements
The following prerequisites should be in place on the server that will host MyST Studio prior to running the MyST installer.
- Java 1.7+ is installed.
- Docker 1.10+ and Docker Compose is installed.
The MyST license tar.gz file must be available. This is provided when you sign up for MyST Studio.
After the installation, internet access is required for the latest version of MyST to be pulled down directly from the public MyST Docker Registry. If you are behind an internet proxy, please follow these steps to ensure all installation dependencies can be directly pulled from the Rubicon Red Docker Registry.
If you are unable to use Docker, there are details on non-Docker installation here
Network Requirements
As MyST is a management tool, it is best suited in a management network so that it can access all of the environments that it needs to manage. MyST will connect to the instances that it manages via ssh
protocol and tcp
as needed. More details on network requirements are available here section.
Installation in 3 simple steps
Once the MyST installer has been download, it can be used to establish the MyST stack on docker
. Once the System Requirements are in place, the process of getting up and running is a 3 steps process.
- Run the MyST Installer
java -jar fc-installer-6.3.1.jar
- After running the installer, MyST can be started with
/opt/myst-studio/bin/start.sh
- By default, the MyST Studio console is accessible from
https://localhost/console
.
Detailed installation instructions are available within the Docker-based Installation Guide. For non-Docker installation, please consult the Alternative Installations Guide