gocd-janitor

Tiny program that helps you with cleaning up artifacts on GoCD servers. There was a discussion on GoCD mailing list and my own not-so-good experience managing artifacts on GoCD led me to this.

How does Janitor work?

We try to keep a default set of runs for each pipeline and all it's upstream dependencies.
You can also override the value of runs to keep per pipeline in the configuration

Usage

$ mvn clean package
$ java -cp target/gocd-janitor-0.2.0-jar-with-dependencies.jar in.ashwanthkumar.gocd.artifacts.Janitor --help
Option (* = required)  Description                           
---------------------  -----------                           
* --config             Path to janitor configuration         
--delete-artifacts     Delete the artifacts                  
--dry-run              Doesn't delete anything just emits the
                         files for deletion                  
--move-artifacts       Move the artifacts to <destination path>
--help                 Display this help message             

----

$ java -cp target/gocd-janitor-0.2.0-jar-with-dependencies.jar in.ashwanthkumar.gocd.artifacts.Janitor --conf gocd-purge.conf --dry-run --delete-artifacts

Configuration

gocd.janitor {
  server = "http://ci-server:8080"
  username = "admin"
  password = "badget"

  # Path to the location where we've all the pipeline directories
  artifacts-dir = "/data/go-server/artifacts/pipelines/"

  # Default number of *successful* versions to keep for all the pipelines
  pipeline-versions = 5

  # (Optional) Global prefix while selecting the pipelines (default - "")
  pipeline-prefix = "pipeline-prefix"

  # (Optional) Specify the list of pipelines you want to ignore
  pipelines-to-ignore = ["pipeline1", "pipeline2"]

  # Override the versions to keep for specific pipelines
  # To leave this key blank, specify it like: pipelines = []
  pipelines = [{
    name = "Pipeline1"
    runs = 2
  }]
}

FAQs

Where do I run the Janitor from?

It is expected to be run on the go server machine where the artifacts are stored. If you run agents on the server, then you create a pipeline and assign it to an agent on the server machine.

Is Janitor a GoCD Plugin?

No this is not a plugin and you can't use it as a plugin either.

Do I need to add every new pipeline being created to the config?

No, we will automatically pick up the new pipeline on the next run of the Janitor.

Is there a way to run the Janitor without deleting anything?

Yes, you could run the janitor with --dry-run flag. It doesn't delete but just print the directories that will be deleted.

How does Janitor decide if the Pipeline run is a Failure or a Success?

Since there is no universal way to say if the pipeline has failed or not, because a stage could fail, but we could deem it unimportant (for the time being) and continue rest of the pipeline.

Janitor is sensitive about what it considers as failures. The conditions are as follows

Any 1 stage failure is considered a pipeline failure.
If the pipeline doesn't run to completion (because of it being paused or locked) it is considered a failure.

But Janitor will never remove the latest run, so you don't have to worry about a running instance of the pipeline.

Does Janitor respect the "Never Cleanup Artifacts" option of the pipeline?

No. That's inside the GoCD's configuration and we don't have a way to syncing it yet. If you want this feature, please raise it as an Issue or even better send a Pull Request 😄

License

Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0

ashwanthkumar/gocd-janitor