README.md in mission_control-servers-0.0.1 vs README.md in mission_control-servers-0.0.2
- old
+ new
@@ -1,34 +1,92 @@
# MissionControl::Servers
-Don't use this yet. It will be a gem to monitor servers and send the data to Mission Control.
+The goal of MissionControl::Servers is to provide a simple monitoring of the resources
+on your Ruby on Rails application. You can either use this directly on the projects or create a separate Ruby on
+Rails application to mount this in.
## Installation
Add this line to your application's Gemfile:
```ruby
bundle add "mission_control-servers"
bin/rails mission_control_servers:install:migrations
```
+Add a mount to your `config/routes.rb`
-# Usage
+```ruby
+mount MissionControl::Servers::Engine => "/mission_control-servers"
+```
-Use within your own Rails application or have a separate application to monitor your servers.
+## Configuration
-You'll make a POST request to the endpoint with the following parameters:
+Within your application, you can make some configuration changes in how the gem operates. Below are the default
+configuration options. You can override these options by creating an initializer file.
+For example, if you're wanting to use MissionControl::Servers in a single project, then there is no need to have
+the ability to create multiple projects. You can set the `single_project_mode` to true which will hide the ability
+to create new projects.
+
+```ruby
+# config/initializers/mission_control_servers.rb
+MissionControl::Servers.configure do |config|
+ config.single_project_mode = true
+end
```
-endpoint="https://YOUR_APPLICATION/mission_control-servers/projects/YOUR_TOKEN/ingress"; cpu_usage=$(top -bn1 | grep "Cpu(s)" | sed "s/.*, *\([0-9.]*\)%* id.*/\1/" | awk '{print 100 - $1""}'); mem_free=$(free -m | awk '/^Mem:/ {print $2}'); mem_used=$(free -m | awk '/^Mem:/ {print $7}'); disk_free=$(df -h | awk '$NF=="/"{print $4}'); curl -X POST $endpoint -d "service[cpu]=$cpu_usage&service[mem_used]=$mem_free&service[mem_free]=$mem_used&service[disk_free]=$disk_free&service[hostname]=${hostname}"
+
+## Usage
+
+Create a project. Once you create a project, you can easily copy the script specific to that project.
+
+Install a script which captures:
+
+- Hostname
+- CPU Usage
+- Memory Usage
+- Free Memory
+- Free Disk Space
+
+The data will be retained for 7 days automatically. After 7 days, the data will start truncating itself
+so that it doesn't take up much disk space within the database.
+
+## Protecting the Dashboard
+
+You can protect the dashboard by using a constraint. This will allow you to only allow certain users to access
+the dashboard. However, the ingress still needs to be accessible by the servers which are being monitored.
+
+```ruby
+Rails.application.routes.draw do
+ constraints AdminConstraint do
+ mount MissionControl::Servers::Engine => "/mission_control-servers"
+ end
+ post '/mission_control-servers/projects/:project_id/ingress', to: 'mission_control/servers/ingresses#create'
+end
```
-This script should be added to a cron job to run every minute (or however often you want to monitor your servers).
+In this example, we have directly given a path to the ingress, but locked down everything else to the AdminConstraint.
+The AdminConstraint takes in the request and calls the `matches?` method. If the method returns true,
+then the routes will be defined for that request.
-Change `YOUR_APPLICATION` to your application's endpoint and `YOUR_TOKEN` to your project's token.
+```ruby
+class AdminConstraint
+ def self.matches?(request)
+ true
+ end
+end
+```
-# Screenshots
+## Screenshots
-These are going to change rapidly as the project is in development.
+Simple Installation
-
+
+
+View all of your projects
+
+
+
+Detailed Dashboard updates automatically
+
+
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).