Code Monkey home page Code Monkey logo

rultor's Introduction

Rultor logo

EO principles respected here DevOps By Rultor.com We recommend IntelliJ IDEA

mvn codecov PDD status codebeat badge Codacy Badge Hits-of-Code Availability at SixNines

Rultor is a DevOps team assistant. It helps your programmers and release managers automate routine operations (merge, deploy, and release) with an easy-to-use intuitive chat-bot interface. Just say @rultor hello in any of your GitHub issue and the conversation will start.

Full documentation is at doc.rultor.com

Schema for .rultor.yml file

Need help online? Try our Telegram group.

These blog posts may be helpful:

Watch these videos to understand what Rultor is for:

Default Docker image is yegor256/rultor-image

What Problems Does Rultor Solve?

Automated deployment scripts have been around for some time. Rultor attempts to tackle the problems those scripts do not.

The first benefit of Rultor is that it gives you isolation of your deployment script in its own virtual environment by using Docker containers. This substantially reduces the amount of external state that could affect your build and makes errors more easily reproducible.

Additionally, because of the way Rultor integrates with modern issue trackers, all the logs are stored and published to the ticket on which Rultor was mentioned. Making vital information easily accessible to all developers.

Rultor performs pre-flight builds. Instead of merging into master and then seeing if your changes broke the build or not, Rultor checks out the master branch, apply your changes to it, then runs everything it was set up to run. If, and only if, everything goes well, Rultor merges the changes into master. This programmatically prevents the master from being broken by developers. Not having to worry about breaking the build for everyone else has a very positive impact in the way developers write code, increasing their productivity and mitigating their fear of making mistakes.

Lastly, Rultor provides an integrated and humanized interface to DevOps tools, as a human-readable sentence suffices to trigger a merge or a release.

How Rultor Works?

Once Rultor finds a merge command in one of your GitHub pull requests, it does exactly this:

  1. Reads the .rultor.yml YAML configuration file from the root directory of your repository.
  2. Gets automated build execution command from it, for example bundle test.
  3. Checks out your repository into a temporary directory on one of its servers.
  4. Merges pull request into master branch.
  5. Starts a new Docker container and runs the build execution command in it, for example bundle test.
  6. If everything is fine, pushes modified master branch to GitHub.
  7. Reports back to you, in the GitHub pull request.

You can see it in action, for example, in this pull request: jcabi/jcabi-github#878.

How to Create a New Server

Rultor expects a server with installed Docker to be available. It logins there via SSH and starts Docker containers per each task. This is how you configure a server from scratch (as root at Ubuntu 20.04):

$ apt-get install -y bc
$ groupadd docker
$ adduser rultor
$ gpasswd -a rultor docker
$ echo 'rultor ALL=(ALL) NOPASSWD: ALL' >> /etc/sudoers
$ mkdir /home/rultor/.ssh
$ cat > /home/rultor/.ssh/authorized_keys
$ chown rultor:rultor -R /home/rultor/.ssh
$ chmod 600 /home/rultor/.ssh/authorized_keys

Make sure the b4.rultor.com is pointing to the server. At the moment the hosted app is working with a single server only, by this particular domain name.

rultor's People

Contributors

aistomin avatar alex-palevsky avatar anouarbadri avatar bharatbolisetty avatar caarlos0 avatar cvrebert avatar dalifreire avatar essobedo avatar filfreire avatar gangababu avatar gumbelmj avatar marczeeee avatar maurezen avatar mentiflectax avatar nathansgreen avatar original-brownbear avatar oruam85 avatar palyuga avatar pnatashap avatar renovate[bot] avatar rultor avatar stayathomedad avatar tannakartikey avatar vaibhavpaliwal99 avatar valery1707 avatar vkuchyn avatar volodya-lombrozo avatar wentwog avatar xupyprmv avatar yegor256 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

rultor's Issues

com.rultor.drain.Syslog

Let's create a drain that logs everything to syslog, something like:

com.rultor.drain.Syslog("papertrailapp.com", 53649, "USER")

sharing of units

Let's add a feature of units sharing between accounts (for free and for money)

Quartz through SQS

Let's connect Quartz to SQS to guarantee un-interrupted flow of events

health check page

Let's create a health check web page that would show statistics of all components and they health status

spec not found when output is completely broken

java.lang.IllegalStateException: signal 'spec' not found
    at com.rultor.aws.S3Pulse.find(S3Pulse.java:140)
    at com.rultor.aws.S3Pulse.spec_aroundBody6(S3Pulse.java:102)
    at com.rultor.aws.S3Pulse$AjcClosure7.run(S3Pulse.java:1)
    at org.aspectj.runtime.reflect.JoinPointImpl.proceed(JoinPointImpl.java:149)
    at com.jcabi.aspects.aj.MethodCacher$Tunnel.through(MethodCacher.java:280)
    at com.jcabi.aspects.aj.MethodCacher.cache(MethodCacher.java:126)
    at com.rultor.aws.S3Pulse.spec(S3Pulse.java:102)
    at com.rultor.web.PulsesRs.pulse(PulsesRs.java:122)

plain text units

Let's enable plain text units, which would start with "text\n" prefix and the rest would be treated as plain text

com.rultor.env.ec2.CFStacks

Let's create a new class com.rultor.env.ec2.CFStacks to enable environments instantiation through AWS CloudFormation:

com.rultor.env.ec2.CFStacks(
  "... CF template ...",
  "instance-type", "security-group", "key-pair",
  "AWS-key", "AWS-secret"
)

com.rultor.env.SSHPrerequisites

Let's create environments that upload prerequisites by SSH to every new environment enclosed:

com.rultor.env.SSHPrerequisites(
  original-environments,
  {
    "test.txt": "some text content",
    "img/binary.jpg": com.rultor.data.Base64("0L/RgNC40LLQtdGCIQ==")
    "loaded-through-http.html": com.rultor.data.WebContent("http://www.google.com")
  }
)

multi-line string literals

Would be convenient to have them, for example:

java.lang.String(
  """
  this is a multi line string
  where all leading spaces are
  automatically removed and trailing
  line endings are preserved
  """
)

And get rid of BigText syntax.

enable maps and arrays in unit specs

Let's enable arrays and maps in specs, for example:

com.rultor.base.Abc(
  ["first", "second", com.rultor.base.Test("third")],
  {"first": 12, "second": 34, "third": "something else"}
)

templates

Let's introduce re-usable templates of units. For example, unit foo will look like:

com.Foo($alpha, $beta, "test")

Later, it can be used as:

urn:github:526301:foo("hello", "world")

ClasspathRepo doesn't understand super-classes and scalars

The problem is that ClasspathRepo doesn't understand super-types and scalars. For example, if the constructor is defined as

public Foo(int abc, Bar cde) {
  // ...
}

And spec looks like:

Foo(5, ChildOfBar(14))

ClasspathRepo fails to understand them both. It expects a constructor with <init>(long, Bar) signature.

enable custom JAR libraries

Users should be able to register their own JAR libraries (or maybe source code), in order to use custom pulseable objects.

inverse deployment for conveyer

Let's implement an inverse deployment mechanism for conveyer-rultor module. It has to be hosted on a standalone machine (in AWS) and should monitor its own activity. When no threads are busy with any works it has to shut itself down. The system-level bash script should pick it up and start again, fetching the newest version from repository.

Besides, would be nice, before shutting down, to compare its own version with the version published by rultor-web module.

OnCommit and supplementary SCM classes/interfaces

OnCommit for SCM management. For example:

OnCommit(branch, rultor-build, sns)
Branch(git, "master") or Branch(svn, "/trunk" or "/branches/test")
Git(servers, "https://...", git-ssh-key)
Subversion(servers, "http://", "user", "password")
ParametrizedBuild(servers, "git checkout …").build(map of params)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.