Skip to content
This repository has been archived by the owner on Sep 6, 2022. It is now read-only.

Latest commit

 

History

History
56 lines (42 loc) · 3.38 KB

getting_started.md

File metadata and controls

56 lines (42 loc) · 3.38 KB
Raw

Getting started

Getting started with Onix is easiy and required basically only two steps:

Step 1: Deploy Container Images

The easiest way to get started is to deploy Onix from containers. Ready to use container images are provided on docker hub for each of the components of Onix (e.g. database, web api, user interface). For each component there are two repositories. One containing the stable GA release versions, the other containing latest snapshot releases.

There are different options to get started easily:

Option A: Deploy Onix via Docker Compose

To do that you will need the following dependencies in your system:

Refer to the documentation here to install Onix using docker-compose.

Option B: using OpenShift

Deploy using OpenShift is straightforward.

Create an OpenShift project and deploy using one of the provided templates here.

Option C: using Kubernetes and Helm Charts

To install Onix in plain Kubernetes, a Helm Chart will be provided soon.

Step 2: Initial contact using the Web API service

The easiest way to trying the service is via the Swagger API as describe below.

  1. Open the Swagger UI (using the endpoint <YourHost>:<YourPort>/swagger-ui.html) and navigate to the createOrUpdate PUT operation. E.g using docker on localhost, the link would be http://localhost:8080/swagger-ui.html#/web-api/createOrUpdateItemTreeUsingPUT. For OpenShift, replace with <YourHost>:<YourPort> with the route.
  2. Paste the payload example found here in the payload box
  3. Execute the request to create the inventory in the CMDB
  4. You should see the response of the web service showing no errors

Step 3: Check Image Configuration

The Container Images use env variables for their internal configuration. Defaults should be okay for first experiments, but check that they fit to your environment.

Onix Web API Image

The following variables are available to configure the Web API image:

Variable Description Default
HTTP_PORT the port number web service is listening on. 8080
DB_USER the user the service uses to connect to the database. onix
DB_PWD the database user password. onix
DB_HOST the database server hostname. localhost
DB_PORT the port number the database server is listening on. 5432
DB_NAME the name of the cmdb database the service attempts to connect. onix
MGMT_ENDPOINT_METRICS_ENABLED enable metrics endpoints. true
DS_PREP_STMT_CACHE_SIZE number of prepared statements that the JDBC driver will cache per connection. 250
DS_PREP_STMT_CACHE_SQL_LIMIT maximum length of a prepared SQL statement that the driver will cache. 2048
DS_CACHE_PREP_STMTS enable the cache. true
DS_USE_SERVER_PREP_STMTS add support for server-side prepared statements. true