Installation

Installing the Console #

INFINI Console supports mainstream operating systems and platforms. The program package is small, with no extra external dependency. So, the gateway can be installed very rapidly.

Preparation before Installation #

Prepare an Elasticsearch cluster that can store data, which is required to be version 7.3 and above, for storing related data on the INFINI Console.

Downloading #

Select a package for downloading in the following URL based on your operating system and platform:

https://release.infinilabs.com/console/snapshot

Container Deployment #

INFINI Console also supports Docker container deployment.

Learn More

Configure #

After downloading and decompressing the installation package of INFINI Console, open the console.yml configuration file, we can see the following configuration sections:

#Elasticsearch cluster version should be v7.3+ for storing INFINI Console related data 
elasticsearch:
  - name: default
    enabled: true
    monitored: true
    endpoint: http://192.168.3.188:9299
    basic_auth:
      username: elastic
      password: ZBdkVQUUdF1Sir4X4BGB

In general, we only need to modify the endpoint in the configuration. If Elasticsearch has security verification enabled, we need to modify the username and password configurations.

The username here requires full access to cluster metadata, index metadata, and .infini* indexes, and to create index templates.

For the initial settings of the index template, please refer here to Learn more

Starting the Console #

The Console can be started by directly running the program (the mac version is used here, and the program file names of different platforms are slightly different), as follows:

➜ BOOTSTRAP_USERNAME=admin BOOTSTRAP_PASSWORD=123456 ./console-mac-amd64


   ___  __   ___         ___
  / __\/ /  /___\/\ /\  /   \
 / /  / /  //  // / \ \/ /\ /
/ /__/ /__/ \_//\ \_/ / /_//
\____|____|___/  \___/___,'
   ___  ___    __  __    ___  __   __
  / __\/___\/\ \ \/ _\  /___\/ /  /__\
 / /  //  //  \/ /\ \  //  // /  /_\
/ /__/ \_// /\  / _\ \/ \_// /__//__
\____|___/\_\ \/  \__/\___/\____|__/


[CONSOLE] INFINI Cloud Console, The easiest way to operate your own elasticsearch platform.
[CONSOLE] 0.3.0_SNAPSHOT, 2022-03-31 10:26:41, 2023-12-31 10:10:10, fa04f6010144b7c5267c71ccaee30230ddf2432d
[03-31 20:27:40] [INF] [app.go:174] initializing console.
[03-31 20:27:40] [INF] [app.go:175] using config: /Users/shiyang/infini/console-0.3.0_SNAPSHOT-447-mac-amd64/console.yml.
[03-31 20:27:40] [INF] [instance.go:72] workspace: /Users/shiyang/infini/console-0.3.0_SNAPSHOT-447-mac-amd64/data/console/nodes/c92psf1pdamk8rdhgqpg
[03-31 20:27:40] [INF] [app.go:283] console is up and running now.
[03-31 20:27:40] [INF] [metrics.go:63] ip:192.168.3.12, host:shiyangdeMacBook-Pro.local, labels:, tags:
[03-31 20:27:40] [INF] [elastic.go:136] loading [5] remote elasticsearch configs
[03-31 20:27:40] [INF] [actions.go:280] elasticsearch [default] is available
[03-31 20:27:40] [INF] [actions.go:280] elasticsearch [lsy_cluster_1] is available
[03-31 20:27:40] [INF] [actions.go:280] elasticsearch [es-v710] is available
[03-31 20:27:40] [INF] [actions.go:280] elasticsearch [es-v7140] is available
[03-31 20:27:40] [INF] [ui.go:197] ui listen at: http://0.0.0.0:9000
[03-31 20:27:40] [INF] [module.go:116] all modules are started

Seeing the above startup information, it means that the Console has successfully run and monitored port 9000. You can log in and use by accessing port 9000 in the browser. The initial user name and password information are passed through the environment variables BOOTSTRAP_USERNAME, BOOTSTRAP_PASSWORD ` to set.

Shutting Down the Console #

To shut down INFINI Console, hold down Ctrl+C. The following information will be displayed:

^C
[CONSOLE] got signal: interrupt, start shutting down
[03-31 20:33:10] [INF] [module.go:145] all modules are stopped
[03-31 20:33:10] [INF] [app.go:267] console now terminated.
[CONSOLE] 0.3.0_SNAPSHOT, uptime: 5m30.307832s

   __ _  __ ____ __ _  __ __
  / // |/ // __// // |/ // /
 / // || // _/ / // || // /
/_//_/|_//_/  /_//_/|_//_/

©INFINI.LTD, All Rights Reserved.

System Service #

To run the Console as a background task, run the following commands:

➜ ./console -service install
Success
➜ ./console -service start
Success

Unloading the service is simple. To unload the service, run the following commands:

➜ ./console -service stop
Success
➜ ./console -service uninstall
Success