Contribution to Lcm Controller and K8s Plugin (Applcm)¶
This section provides details on how to participate/contribute to the LCM controller project.
Build local development environment¶
This section will guide developers to build LCM controller module locally and help developers to quickly understand and develop code
The local startup of LCM controller depends on:
- DataBase
In order to build a local environment, the final startup sequence is DataBase -> LCMController
DataBase¶
Download and install postgres 12.3 database
Set login name and password, such as lcmcontroller
Create a database named lcmcontrollerdb
LCM contorller¶
Download LCM Controller Code
Configure the runtime environment variables (using GO Land as an example)
Update certificates path in app.conf
Run main to start LCM controller
K8s plugin¶
Download K8s plugin code
Configure the runtime environment variables (using GO Land as an example)
Update certificates path in config.yaml
Run main to start K8s plugin.
How to generate swagger documentation for Lcm Controller¶
Download LCM Controller Code
Prerequisites¶
Step 1 - Install go lang
cd ~
curl -O https://dl.google.com/go/go1.10.3.linux-amd64.tar.gz
tar xvf go1.10.3.linux-amd64.tar.gz
sudo chown -R root:root ./go
sudo mv go /usr/local
sudo nano ~/.profile
export GOPATH=$HOME/mecm-applcm
export PATH=$PATH:/usr/local/go/bin:$GOPATH/bin
export GOROOT=$HOME/go
export GOPATH=$HOME/mecm-applcm
export PATH=$PATH:$GOROOT/bin:$GOPATH/bin
source ~/.profile
Step 2 - Install bee
You will need to install or upgrade Beego and the Bee dev tool:
go get -u github.com/beego/beego/v2
go get -u github.com/beego/bee/v2
bee
Change runmode configuration to dev from prod in app.conf file
Now coming to the auto-generation of documentation, end the server’s session and use this command:
bee run -gendoc=true -downdoc=true
Now, go to the browser and type:
https://localhost:8094/swagger/