cb-admin v0.29.0

CB Admin

This repository contains dev-op code for startup, deploy & bump repos.

Prerequisites

• Node JS (lts/gallium) - Recommend using nvm
• Docker - Install
• Docker Compose - Install
• Kubernetes - Install
• For AWS Management:
  • aws-cli which you can install it from here
  • eksctl which you can install from here
  • kubectl here you have the installation instructions.
  • k8lens (Optional) you can download this to manage kubernetes or do it from the terminal instead.
  • kustomize you can install it from here
  • Follow these and these instructions in order to manage aws cluster.

What is this repository for?

Dockerfiles and everything needed to run the entire infrastructure.

How do I get set up?

To work on this project you only need nodejs stable and then just run:

npm run build: to build the environment assets.

npm start: to start the infrastructure.

Available nodejs scripts

• npm run build [:SSH_KEY] [:CLEAN]: build the entire environment. This has an optional parameter to set the ssh key for cloning repos. You can use it by running npm run build -- /path/to/ssh_key.
• npm run build:module [:MODULE] [:SSH_KEY] [:CLEAN]: build some specific module.
• npm start [:ENVIRONMENT] [:DETACHED]: start some specific infrastructure on docker compose. Available infrastructures are inside the folder environment. By default, is complete.
• npm run stop [:ENVIRONMENT]: stops some specific infrastructure. Available infrastructures are inside the folder environment. By default, is complete.
• npm run modules:version: shows current module versions.
• npm run modules:update: update the module version with the latest.
• npm run libraries:version: shows current libraries versions.
• npm run libraries:update: update the libraries version with the latest.
• npm run configuration:show: this will retrieve the configuration values for the repositories.
• npm run configuration:encrypt: this will encrypt the rust file to generate the pocket configuration binary.
• npm run configuration:decrypt: this will decrypt the rust file to generate the pocket configuration source code.
• npm run start:tmux [:WORKSPACE_PATH]: this is a script to be used by developers who use tmux terminal in order to start everything on a tmux terminal.

Releases

You can review this here.

Frontend developers

If you are working on a UI and you want to have all the backend side working you can just run npm run start:backend in order to start the message producer, event bus and backend modules. Then you can start the UI project to consume the producer Rest API.

Backend developers

If you work on some specific module you can just start kafka and then start the different modules separately. To do so you have to run npm run start:kafka, that will start only the event bus.

If you want to select which modules to start or not you can modify the files under environment/[arch].compose.yml.

Running entire architecture

To run everything you just have to execute npm start and that will start the entire architecture.

Module versions

By default, when you run npm run build will generate images for the latest versions of the different modules. You can change that in the file modules.json in the root of the project.