Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/snetsystems/cloudhub

CloudHub is a totally designed system that lets you monitor and manage the availability of something like servers, applications, virtual machines, Kubernetes, and so on.
https://github.com/snetsystems/cloudhub

128-technology alert chronograf cloud cloudhub go helm influxdata infrastructures kapacitor kubernetes monitoring react saltstack telegraf typescript visualization vmware

Last synced: 3 months ago
JSON representation

CloudHub is a totally designed system that lets you monitor and manage the availability of something like servers, applications, virtual machines, Kubernetes, and so on.

Host: GitHub
URL: https://github.com/snetsystems/cloudhub
Owner: snetsystems
License: other
Created: 2019-07-12T06:03:25.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2024-09-30T07:58:27.000Z (3 months ago)
Last Synced: 2024-09-30T13:41:18.638Z (3 months ago)
Topics: 128-technology, alert, chronograf, cloud, cloudhub, go, helm, influxdata, infrastructures, kapacitor, kubernetes, monitoring, react, saltstack, telegraf, typescript, visualization, vmware
Language: TypeScript
Homepage: https://seversky.atlassian.net/wiki/spaces/CSHD/pages/219414598/Introduction
Size: 14.3 MB
Stars: 20
Watchers: 4
Forks: 9
Open Issues: 45
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# CloudHub

## Intro

**CloudHub** is a totally designed system that lets you monitor and manage the availability of something like servers, applications, virtual machines, Kubernetes, and so on. And this is **another branch** of an open-source web application derived from Influxdata's **_Chronograf_** written in Go and React.js that provides the tools to visualize your monitoring data and easily create alerting and automation rules.

Therefore, CloudHub has been enhanced by adding our direction, such as automation of configuration management(via **_SaltStack_ Rest API**) and monitoring the systems or applications over several Clouds.

CloudHub has been started with _Chronograf_ version **1.7.11**.

### Using the basic common features

As we follow on using guides like the way of _TICK_ Script or _Flux_ queries, for more informations of the basic common features between _Chronograf_ 1.7.11 and CloudHub refer to the following link.

[Github for **_chronograf_**](https://github.com/influxdata/chronograf/blob/master/README.md)

[Documentation for **_TICK Stack_**](https://docs.influxdata.com/)

But you should use [Forked **Snetsystems/telegraf**](https://github.com/snetsystems/telegraf/releases)

### Test Environment

For running this project, maybe, you should get the environment for test data and composition like telegraf, kapacity and influxdb (but not need chronograf).
This **_Sandbox_** provided by _sysnetsystems_ will help to do.

[Download **snetsystems/sandbox**](https://github.com/snetsystems/sandbox)

For the agent management or vsphere, k8s inventory viewer test, you prepare to Salt master, api, minion.

You should use [Forked **Snetsystems/salt**](https://github.com/snetsystems/salt/)

[Documentation for **_SaltStack_** ](https://docs.saltstack.com/en/latest/contents.html)

## How to use Cloudhub

[Documentation for **CloudHub** Guide (Korean)](https://seversky.atlassian.net/wiki/spaces/CSHD/overview)

## Key Differences against _Chronograf_ at this point(version).

- Add a Basic(id/pw) authentication and management feature.
- Regarding to above, an activity log is added.
- Add **multi-tenant** feature across Users-Roles-Groups-DataSources.
- Hosts to Infrastructures and basic charts added.
- Infrastructure Topology Map authoring feature by user group.
- Status Overview of entire nodes(About CPU Temperature, CPU Memory, Disk usage, etc.).
- Show IPMI Sensor Data.
- Addable to connect to Public Cloud(AWS, GCE).
- Visualization added by criteria of Applications.
- Integration a backend with **_SaltStack_**.
- Avoid CORS Problem: `Web UI > CloudHub Salt Proxy > Salt API Server > Salt Master > Salt Minions.`
- Telegraf agent management and configuration editing and deploying remotely via **_SaltStack_ Rest API**.
- Web SSH Terminal Console feature.
- Connection to hosts using ssh protocol via CloudHub WebSocket Proxy.
- Add **Statistic graphs** for data visualization.
- Optionable Addon features.
- **_VMWare_ Infrastructure** Viewer.
- via **_VSphere_** API and **_Salt_**
- **\_OpenStack Infrastructure\_\_** Monitoring.
- **_K8s Infrastructure_** Diagram & Viewer.
- via customized `Salt Kuberetes` Module.
- **_AWS_** Instances Monitoring.
- **_GCE_** Instances Monitoring.
- SWAN Router & SDPlex(Oncue) Features.
- Bare-metal Server Remote Management via **IPMI**

## Change log

You could know the changelog by versions via the follows.

Version <= v1.2.0: [Projects(Legacy)](https://github.com/snetsystems/cloudhub/projects?query=is%3Aclosed&type=classic)

Version >= v1.3.0: [Projects(Newly)](https://github.com/snetsystems?tab=projects)

## Setting in VSCode

- Add the followings into **User Setting** or **Workspace Setting**.

```json
{
"terminal.integrated.shell.windows": "C:\\Program Files\\Git\\bin\\bash.exe",
"terminal.integrated.rightClickBehavior": "default",
"terminal.explorerKind": "external",
"terminal.integrated.copyOnSelection": true,
"terminal.integrated.scrollback": 10000,
"breadcrumbs.enabled": true,
"editor.renderControlCharacters": true,
"editor.largeFileOptimizations": false,
"editor.formatOnSave": true,
"editor.renderWhitespace": "none",
"editor.wordWrap": "on",
"workbench.startupEditor": "newUntitledFile",
"explorer.confirmDelete": false,
"explorer.confirmDragAndDrop": false,
"files.eol": "\n",
"go.formatTool": "goimports",
"go.lintOnSave": "package",
"go.autocompleteUnimportedPackages": true,
"prettier.singleQuote": true,
"prettier.bracketSpacing": false,
"prettier.semi": false,
"prettier.trailingComma": "es5",
"prettier.arrowParens": "avoid",
"eslint.alwaysShowStatus": true,
"editor.defaultFormatter": "esbenp.prettier-vscode",
"files.associations": {
"*.yml": "yaml"
},
"window.zoomLevel": 0,
"gitlens.views.repositories.files.layout": "tree",
"git.ignoreLegacyWarning": true,
"screencastMode.onlyKeyboardShortcuts": true,
"diffEditor.ignoreTrimWhitespace": false,
"workbench.sideBar.location": "left"
}
```

## How to build

### Preparing dependencies

- CloudHub works with **go 1.21.x**, **node 12.x ~ node 14.x**, and **yarn 1.15.x ~ 1.22.x**. Thus, you have to install that according to each offcial guide.

- Yarn install example:
```bash
$ npm install --global [email protected]
```
- Install **protoc**(protocol buffer compiler)
- [Download here](https://github.com/protocolbuffers/protobuf/releases) proper package.
- Unzip and then add `bin/protoc` or `bin/protoc.exe` to $PATH env. or simply put into ` $GOPATH/bin` or ` $GOROOT/bin/` diretory.
- In the case of Windows, it cannot be invoked "make" command,
So you need to download and install [GNUMake](http://gnuwin32.sourceforge.net/packages/make.htm) for windows.
- [Download here](http://gnuwin32.sourceforge.net/downlinks/make.php)

### Getting the source code from github.

[If you're on Windows, run "Git Bash" and] type the followings.

```bash
# If you're on Windows, run "Git Bash" and type the followings.

$ git clone https://github.com/snetsystems/cloudhub.git
$ cd cloudhub
$ make
```

If well done, you can see the binary.

```bash
$ cd backend/cmd/cloudhub
$ ls -l
total 28072
...
-rwxr-xr-x 1 Snetsystems 197121 28610048 Jul 15 09:09 cloudhub
```

Once run cloudhub, 8888 port will be listened.

```bash
$ ./cloudhub
```

You can see the CloudHub UI via browser: http://localhost:8888

## How to debug via VSCode for Development.

Run "_cloudhub.code-workspace_" within cloudhub folder.

```bash
$ code cloudhub.code-workspace
```

Simply, select **"Launch Server"** and then run.

Also, for UI debugging, select **"Launch Chrome"** and then run debug.

For continuous debugging, you can use **"Launch Chrome"** after _**yarn start**_

> [Note] On Windows, you have to use **"Launch Chrome"** after _**yarn start**_

> [Note]

> For continuous debugging, you need to add **_develop mode_** into the running argument.

> We already prepared **"_.vscode/launch.json_"** and **"_.vscode/settings.json_"**
>
> > - Using **GO111MODULE**.
> > - Not need a vendor directory anymore.
> > - Snetsystems Github login setting as a default.
> > - You need to change to the Github's keys of your organization.
> > - If you don't need to login, get rid of the login information.
> > ```json
> > ...
> > "args": [
> > "-l=debug",
> > "-d"
> > "-c=./cloudhub-canned/",
> > "--protoboards-path=./cloudhub-protoboards/",
> > "--auth-duration=0",
> > "-t=74c1e9e245088f060b5bff36b935cd0bf2976d35",
> > "--github-client-id=c170bbdbc5cb2ea8f6d3",
> > "--github-client-secret=55c35715b0e4eebab7edbdeef3081bf890e79d22"
> > ],
> > ...
> > ```

If you run a not login mode, you can use **"Launch Chrome via Proxy"** after _**yarn start**_

```bash
$ cd $CloudHub_PATH/frontend
$ yarn start
yarn run v1.15.2
$ node parcel.jsx
Serving on http://localhost:8080
√ Built in 7.54s.
```