Skip to content

Latest commit

 

History

History
236 lines (157 loc) · 9.62 KB

README.markdown

File metadata and controls

236 lines (157 loc) · 9.62 KB
Raw

OpenRedu Core

Este repositório contem o core do OpenRedu. O openredu-core é a parte central da plataforma social educacional OpenRedu. Também existem alguns subsistemas/serviços que estão em servidores/projetos/repositórios diferentes. A saber:

Setup

Checkout do código:

$ > git clone git@github.com:redu/redu.git
$ > cd redu
$ redu > bundle install --binstubs

Inicialização do MySQL e MongoDB

$ redu > mysqld_safe
121212 08:45:50 mysqld_safe Logging to '/usr/local/mysql/data/scissorhands.local.err'.
121212 08:45:50 mysqld_safe Starting mysqld daemon with databases from /usr/local/mysql/data
$ redu > mongod --journal
redu (master) > mongod --dbpath=$HOME/usr/data/   --journal
Wed Dec 12 08:48:20 [initandlisten] MongoDB starting : pid=4144 port=27017 dbpath=/Users/guiocavalcanti/usr/data/ 32-bit host=scissorhands.local
Wed Dec 12 08:48:21 [initandlisten] waiting for connections on port 27017

Criação dos bancos e esquema:

$ redu > bundle exec rake db:create
$ redu > bundle exec rake db:schema:load

Inserção de dados mandatórios:

$ redu > bundle exec rake bootstrap:all

Inicialização do servidor de busca:

$ redu > bundle exec rake sunspot:solr:start

Indexação dos modelos:

$ redu > bundle exec rake sunspot:solr:reindex

Inicialização do servidor de desenvolvimento:

$ redu > bundle exec rails server

Para mais informações sobre o setup, consultar este guia.

Dependências

Para fazer o Redu funcionar em ambiente de desenvolvimento você precisará instalar as seguintes dependências:

  • MySQL 5.1
  • MongoDB 2.0.6
  • Solr 1.4.0

Coding style

O estilo e padrões de código utilizados estão disponíveis neste guia. Leia com atenção antes de submeter patches.

Contribuições

Pull requests

Os passos para contribuir com a evolução do código, seja para resolução de issue ou criação de features são os seguintes:

  1. Criar um branch novo
  2. Realizar mudanças ou adicionar a feature
  3. Commitar mudanças e enviá-las para o remoto
  4. Realizar pull request e atribuir a um revisor
  5. Caso existam revisões: realizar novos commits no mesmo branch criado e enviar para o remoto

Um exemplo de resolução de issue seguiria o seguinte fluxo:

Assumindo que o issue tenha o ID 1300.

$ redu (master) > git pull origin master
$ redu (master) > git checkout -b issue-1300
$ redu (issue-1300) > git commit -a -m "Minhas modificações"
$ redu (issue-1300) > git push origin issue-1300

Para mais informações sobre como fazer o pull request, consulte este post.

Reportando issues da API

O primeiro passo é decidir em qual repositório criar o issue:

Para problemas na API REST, É importante expressar os problemas em termos de HTTP e não da linguagem utilizada. Por exemplo, ao invés de dizer que o método getUsers() está lançando null pointer, tentem explicar que uma requisição do tipo GET para /api/spaces/1/users está retornando o código 500. Fica mais fácil de investigar dessa forma.

DelayedJob

O DelayedJob é utilizado como infraestrutura para processamento de tarefas em background.

Para reinicializar o DelayedJob, em produção, use monit restart. Por exemplo:

$ > sudo monit restart delayed_job.0
$ > sudo monit restart delayed_job.1
$ > sudo monit restart delayed_job.2
$ > sudo monit restart delayed_job.3

Responsabilidades de cada worker do Delayed Job

  • delayed_job.0 (general): Execução de tarefas gerais como criação de associações entre usuários e postagens no mural (não há necessidade de serem executadas imediatamente).
  • delayed_job.1 (email): Envio de emails.
  • delayed_job.2 (vis): Envio de dados para Vis (requisições HTTP).
  • delayed_job.3 (hierarchy-associations): Criação de associações da hierarquia que precisam ser feitas o quanto antes.

Serviço de entrega de e-mails

Nossos e-mails são entregues pelo Amazon SES. Como a entrega de e-mails é uma tarefa excessivamente bloqueante, isso é feito em segundo plano pelo DelayedJob.

Para utilizar entrega em segundo plano, é necessário chamar o método do ActionMailer da seguinte forma: object.delay(:queue => 'email').method. Onde method é tipo de notificação que deve ser gerada. Por exemplo, para enviar o e-mail de convite, a chamada seria a seguinte:

UserNotifier.delay(:queue => 'email').external_user_course_invitation(user_course_invitation, course)

É importante notar que e-mails devem ser enfileirados na fila email para evitar que o envio dos mesmos afetem a vazão do processamento de outros Jobs. Para cada e-mail será enfileirado um Job do DelayedJob que lidará com a renderização da View e entrega para a Amazon SES.

Para mais informações de uso: bundle exec ar_sendmail_rails3 -h

Deploy

O Redu (http://www.redu.com.br) funciona na infraestrutura da Amazon através do EngineYard. Assumindo que você possua as permissões necessárias, para realizar o deploy basta executar o seguinte comando:

$ > ey deploy -a redu -r master --migrate

Gems em repositórios privados

Existem duas formas de utilizar Gems privados no Redu:

A primeira é colocá-lo em um repositório privado e dar acesso ao usuário tiago-redu. Este usuário possui as credenciais da instância app_master.

A segunda é utilizar o servidor de Gem privado The Shire.

SSH

Para realizar login na instância do Redu via SSH basta executar o seguinte comando:

$ > ey ssh -e production

Ou simplesmente faça login através do SSH:

$ > ssh deploy@redu.com.br

Monitoramento de processos

Em produção utilizamos o Monit para monitorar processos. Para saber quais processos são monitorados e seus estados use a opção summary:

$ sudo monit summary
The Monit daemon 5.0.3 uptime: 7d 22h 12m

Process 'solr_redu_9080'            running
Process 'rabbitmq_ssh_tunnel'       running
Process 'nrsysmond'                 running
Process 'mongo_ssh_tunnel'          running
Process 'mini_httpd'                running
Process 'delayed_job.3'             running
Process 'delayed_job.2'             running
Process 'delayed_job.1'             running
Process 'delayed_job.0'             running
System 'domU-12-31-39-09-9C-54'     running

Para mais informações sobre como utilizar o monit, execute sudo monit -h.

nginx

Em produção o Redu funciona através do Passenger (com o nginx). Para reiniciar o servidor basta reinicializar o serviço nginx:

$ > /etc/init.d/niginx restart

Cache

Utilizamos o Memcached como sistema de caching, o setup é feito por default pelo Engine Yard (ambiente em cluster). Nós apenas configuramos para usar o cliente Dalli em produção.

Espaço utilizado

Para ver todo o espaço utilizado nas intâncias use o seguinte comando: sudo du -H --max-depth=1 .

Licença Utilizada

O pacote global de software Redu tem direitos reservados para vários autores registrado junto ao INPI. Ele é um Software Livre e de Código Aberto e tudo isso é fornecido sob os termos da licença GNU General Public License versão 2 publicada pela Free Software Foundation.

Redu e a documentação do Redu são distribuídos na esperança de que eles vão ser útil, mas SEM NENHUMA GARANTIA; sem mesmo a garantia implícita de COMERCIALIZAÇÃO ou ADEQUAÇÃO A UM DETERMINADO FIM. Consulte a Licença Pública Geral GNU aqui para mais detalhes.