pangea
/
django-orchestra
7
0
Fork 0
Code Issues 1 Pull Requests 2 Packages Projects Releases Wiki Activity

Added docs readme file

This commit is contained in:
Marc Aymerich 2016-02-16 10:13:55 +00:00
parent 374729f6eb
commit 6c665295be
1 changed files with 99 additions and 93 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

192
docs/README.md
View File

@ -4,112 +4,118 @@
1. [PIP-only, Fast deployment setup (demo)](README.md#fast-deployment-setup) 1. [PIP-only, Fast deployment setup (demo)](README.md#fast-deployment-setup)
2. [Docker container (development)](INSTALLDEV.md) 2. [Docker container (development)](INSTALLDEV.md)
3. [Install on current system (production)](INSTALL.md) 3. [Install on current system (production)](INSTALL.md)
1. Copy orchestra SSH key to the servers to be managed (you can use <span title="`orchestra@panel:~ ssh-copy-id root@server.address`">`ssh-copy-id`</span>: ), then Add the servers to be managed by orchestra into the servers section `/admin/orchestration/servers`, then copy orchestra's SSH pubkey to them
1. Copy orchestra SSH key to the servers to be managed, you can use `ssh-copy-id`:
2. Now configure service by service (domains, databases, webapps, websites...): ```bash
1. Add the route through `/admin/orchestration/route/` orchestra@panel:~ ssh-copy-id root@server.address
2. Check and configure related settings on `/admin/settings/setting/` ```
3. Configure related resources if needed `/resources/resource/`, like Account Disc limit and traffic. Then add the servers to orchestra using the web interface `/admin/orchestration/servers`, check that the SSH connection is working and Orchestra can report the uptime of the servers.
3. Test that everything works by creating and deleting services
2. Now configure service by service (domains, databases, webapps, websites, ...):
1. Add the route via `/admin/orchestration/route/`
2. Configure related settings on `/admin/settings/setting/`
3. If required, configure related resources like Account disc limit, VPS traffic, etc `/resources/resource/`
3. Test that everything works as expected by creating and deleting service instances
4. Do the same for the other services 4. Do the same for the other services
3. Configure billing by adding services `/admin/services/service/add/` and plans `/admin/plans/plan/`
1. Once a service is created hit the *Update orders* button 3. Configure billing by adding services `/admin/services/service/add/` and plans `/admin/plans/plan/`. Once a service is created hit the *Update orders* button to create the orders for the existing service instances.
### Architecture ### Architecture
Orchestration Orchestration
Orders Orders
Resources
### Creating new services ### Creating new services
1. Think about if the service can fit into one of the existing models like: SaaS or WebApps, refere to the related documentation if that is the case. 1. Think about if the service can fit into one of the existing service models like: SaaS or WebApps, refere to the related documentation if that is the case.
2. Create a new django app using startapp management command. For ilustrational purposes we will create a crontab services that will allow orchestra to manage user-based crontabs. 2. Create a new django app using `startapp` management command. For ilustrational purposes we will create a crontab services that will allow orchestra to manage user-based crontabs.
`python3 manage.py startapp crontabs` ```bash
3. Add the new *crontabs* app to the `INSTALLED_APPS` in your project's `settings.py` python3 manage.py startapp crontabs
3. Create a `models.py` file with the data your service needs to keep in order to be managed by orchestra ```
3. Add the new *crontabs* app to the `INSTALLED_APPS` in your project's `settings.py`
3. Create a `models.py` file with the data your service needs to keep in order to be managed by orchestra
```python ```python
from django.db import models from django.db import models
class CrontabSchedule(models.Model):
account = models.ForeignKey('accounts.Account', verbose_name=_("account"))
minute = models.CharField(_("minute"), max_length=64, default='*')
hour = models.CharField(_("hour"), max_length=64, default='*')
day_of_week = models.CharField(_("day of week"), max_length=64, default='*')
day_of_month = models.CharField(_("day of month"), max_length=64, default='*')
month_of_year = models.CharField(_("month of year"), max_length=64, default='*')
class Meta:
ordering = ('month_of_year', 'day_of_month', 'day_of_week', 'hour', 'minute')
def __str__(self):
rfield = lambda f: f and str(f).replace(' ', '') or '*'
return "{0} {1} {2} {3} {4} (m/h/d/dM/MY)".format(
rfield(self.minute), rfield(self.hour), rfield(self.day_of_week),
rfield(self.day_of_month), rfield(self.month_of_year),
)
class Crontab(models.Model):
account = models.ForeignKey('accounts.Account', verbose_name=_("account"))
schedule = models.ForeignKey(CrontabSchedule, verbose_name=_("schedule"))
description = models.CharField(_("description"), max_length=256, blank=True)
command = models.TextField(_("content"))
def __str__(self):
return (self.description or self.command)[:32]
```
4. Create a `admin.py` to enable the admin interface class CrontabSchedule(models.Model):
```python account = models.ForeignKey('accounts.Account', verbose_name=_("account"))
from django.contrib import admin minute = models.CharField(_("minute"), max_length=64, default='*')
from .models import CrontabSchedule, Crontab hour = models.CharField(_("hour"), max_length=64, default='*')
day_of_week = models.CharField(_("day of week"), max_length=64, default='*')
class CrontabScheduleAdmin(admin.ModelAdmin): day_of_month = models.CharField(_("day of month"), max_length=64, default='*')
pass month_of_year = models.CharField(_("month of year"), max_length=64, default='*')
class CrontabAdmin(admin.ModelAdmin): class Meta:
pass ordering = ('month_of_year', 'day_of_month', 'day_of_week', 'hour', 'minute')
admin.site.register(CrontabSchedule, CrontabScheduleAdmin) def __str__(self):
admin.site.register(Crontab, CrontabAdmin) rfield = lambda f: f and str(f).replace(' ', '') or '*'
return "{0} {1} {2} {3} {4} (m/h/d/dM/MY)".format(
rfield(self.minute), rfield(self.hour), rfield(self.day_of_week),
rfield(self.day_of_month), rfield(self.month_of_year),
)
class Crontab(models.Model):
account = models.ForeignKey('accounts.Account', verbose_name=_("account"))
schedule = models.ForeignKey(CrontabSchedule, verbose_name=_("schedule"))
description = models.CharField(_("description"), max_length=256, blank=True)
command = models.TextField(_("content"))
def __str__(self):
return (self.description or self.command)[:32]
```
4. Create a `admin.py` to enable the admin interface, refere to [Django Admin documentation](https://docs.djangoproject.com/en/1.9/ref/contrib/admin/) for further customization.
```python
from django.contrib import admin
from .models import CrontabSchedule, Crontab
class CrontabScheduleAdmin(admin.ModelAdmin):
pass
class CrontabAdmin(admin.ModelAdmin):
pass
admin.site.register(CrontabSchedule, CrontabScheduleAdmin)
admin.site.register(Crontab, CrontabAdmin)
```
5. Create a `api.py` to enable the REST API.
6. Create a `backends.py` fiel with the needed backends for service orchestration and monitoring.
```python
import os
import textwrap
from django.utils.translation import ugettext_lazy as _
from orchestra.contrib.orchestration import ServiceController, replace
from orchestra.contrib.resources import ServiceMonitor
5. Create a `api.py` to enable the REST API. class UNIXCronBackend(ServiceController):
6. Create a `backends.py` fiel with the needed backends for service orchestration and monitoring """
```python Basic UNIX cron support.
import os """
import textwrap verbose_name = _("UNIX cron")
from django.utils.translation import ugettext_lazy as _ model = 'crons.CronTab'
from orchestra.contrib.orchestration import ServiceController, replace
from orchestra.contrib.resources import ServiceMonitor def prepare(self):
super(UNIXCronBackend, self).prepare()
class UNIXCronBackend(ServiceController): self.accounts = set()
"""
Basic UNIX cron support. def save(self, crontab):
""" self.accounts.add(crontab.account)
verbose_name = _("UNIX cron")
model = 'crons.CronTab' def delete(self, crontab):
self.accounts.add(crontab.account)
def prepare(self):
super(UNIXCronBackend, self).prepare() def commit(self):
self.accounts = set() for account in self.accounts:
crontab = None
def save(self, crontab): self.append("echo '' > %(crontab_path)s" % context)
self.accounts.add(crontab.account) for crontab in account.crontabs.all():
self.append("
def delete(self, crontab): ```
self.accounts.add(crontab.account) 7. Configure the routing
def commit(self):
for account in self.accounts:
crontab = None
self.append("echo '' > %(crontab_path)s" % context)
chown
for crontab in account.crontabs.all():
self.append("
# if crontab is None:
# self.append("rm -f %(crontab_path)s" % context)
```
7. Configure the routing