getdtk/dtk-server repository overview

⁠Dtk Server

⁠What it is?

Dtk Server is a Ruby based application that handles requests from Dtk Client and sends requests to Dtk Repoman. It manages tenant users, installed and imported component and servie modules, creates and converges service instances and performs all node orchestration.

⁠Usage

⁠Deploying Dtk Server with Docker

Fastest way to deploy Dtk Server is with a Docker container. Docker image getdtk/dtk-server⁠ contains all required services and components for deploying Dtk Server.

⁠Preparation

• Install Docker⁠

• Select a directory on the host (host volume) which will be used by the Docker container for persistence (e.g. /usr/share/docker/dtk), and create dtk.config (e.g. /usr/share/docker/dtk/dtk.config) with following content:

USERNAME=dtk-user
PASSWORD=somepassword
PUBLIC_ADDRESS=<public address of the docker host>
## optionally set git user and email for install-client.sh script
# GIT_EMAIL=
# GIT_USER=

More information about the dtk.config file can be found in dtk.config.example⁠

⁠Bootstrap Method

Run this command to spin up the latest release of Dtk Server, along with dtk-arbiter:

\curl -sSL https://getserver.dtk.io | bash -s /usr/share/docker/dtk

The last argument should be the previously created host volume. Once the command completes successfully, Dtk Server should be listening on the default 8080 port.

⁠Manual method

⁠Starting the container

Start the Dtk Server docker container with the directory from above used as a volume. The docker container requires some ports to be forwared, for example: HTTP, ActiveMQ and SSH port. Example of starting a Docker container:

docker run --name dtk -v /usr/share/docker/dtk:/host_volume -p 8080:80 -p 6163:6163 -p 2222:22 -d getdtk/dtk-server

This will pull the latest available Dtk Server Docker image (getdtk/dtk-server).
Next step is to start the dtk-arbiter container:

docker run --name dtk-arbiter -v /usr/share/docker/dtk:/host_volume -v /var/run/docker.sock:/var/run/docker.sock -e HOST_VOLUME=/usr/share/docker/dtk $additional_args --restart=on-failure -td getdtk/dtk-arbiter

Example of starting a Dtk Server Docker container from a tagged Docker image.

docker run --name dtk -v /usr/share/docker/dtk:/host_volume -p 8080:80 -p 6163:6163 -p 2222:22 -d getdtk/dtk-server:v0.9.0

⁠Connecting to Dtk Server Docker container

After the container is up and running (will take a minute on the first start), you can connect to it via dtk-client⁠, by running the dtk command.

⁠Installing Dtk Client

⁠Bootstrap method

Run this command to automatically install and configure latest release of Dtk Client.

\curl -sSL https://getclient.dtk.io | bash -s /usr/share/docker/dtk

To install a specific release (e.g. 0.11.8):

\curl -sSL https://getclient.dtk.io | bash -s -- -v 0.11.8 /usr/share/docker/dtk

To install a specific release (e.g. 0.11.8):

\curl -sSL https://getclient.dtk.io | bash -s -- -v 0.11.8 /usr/share/docker/dtk

⁠Manual method

Assuming the docker container was started as described above, Dtk Client can be installed and configured automatically running the install-client.sh⁠ script:

./install-client.sh [-u user] [-p port] configuration_path

configuration_path   - location of dtk.config file directory
user                 - user on which to install and configure dtk-client
                       defaults to new user named 'dtk-client
port                 - port where Dtk server is listening
                       defaults to 8080

In case the dtk-client gem is installed standalone without the install-client.sh script, in the Dtk Client prompt you can enter the values set in dtk.config (username, password and instance address).

Unless you have SSL, after the prompt, values for secure_connection and http_port in ~/dtk/client.conf should be changed to false and forwared http port values respectively.

Note that if you need to forward GIT SSH port to a different one, you can use the -e GIT_PORT=<desired_port>.

⁠Upgrading the container

To upgrade Dtk container to a newer release, simply rerun the bootstrap script:

\curl -sSL https://getserver.dtk.io | bash -s /usr/share/docker/dtk

To use the latest docker image which is built from master branch:

\curl -sSL https://getserver.dtk.io | bash -s -- -v latest /usr/share/docker/dtk

To install a specific release (e.g. v0.11.11):

\curl -sSL https://getserver.dtk.io | bash -s -- -v v0.11.11 /usr/share/docker/dtk

⁠License

dtk-server is copyright (C) 2010-2016 dtk contributors

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this work except in compliance with the License. You may obtain a copy of the License in the LICENSE⁠ file, or at:

http://www.apache.org/licenses/LICENSE-2.0⁠

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.