Installation

Installation

Prerequisites

To be able to use the plugin, you must install Gradle 3.0+ or any wrapper associated to your project.

Setup

To be able to use the plugin, you have to add one of the following buildscript snippet:

buildscript {
       repositories {
           jcenter()
       }
       dependencies {
           classpath group: 'io.saagie', name: 'gradle-saagie-plugin', version: '<version>'
       }
   }

   apply plugin: 'io.saagie.gradle-saagie-plugin'

Gradle 2.1+ style:

plugins {
  id 'io.saagie.gradle-saagie-plugin' version '2.0.1'
}

And voila you are ready to use the plugin.

Please note that in case of OOM, you can add org.gradle.jvmargs=-Xmx2048m with enough amount of memory for your usage to gradle.properties file.

Configuration

Configuration object

To configure the plugin, you'll have to add a saagie object in your build script.

The common configuration for all tasks is the following.

saagie {
    server {
        url = <platform_url>
        login = <login>
        password = <password>
        platform = <platform_id>
        proxyHost = <proxy_host>
        proxyPort = <proxy_port>
        acceptSelfSigned = <accept_self_signed>
    }
    ...
    target = <archive_local_path>
}

Properties explanation

• url (mandatory)

  • Url of the manager api this should be the main endpoint of the api regardless of the platform or environment you are using.
  • type: string
  • default: https://manager.prod.saagie.io/api/v1

• login (mandatory)

  • Data Fabric's account login.
  • type: string
  • default:

• password (mandatory)

  • Data Fabric's account password.
  • type: string
  • default:

• platform (mandatory)

  • This should be the id of the platform or environment you are willing to work on.
  • type: int
  • default:

• proxyHost

  • Whenever you have to use a proxy to access to your platform, you should provide the host of said proxy.
  • type: string
  • default:

• proxyPort

  • Whenever you have to use a proxy to access to your platform, you should provide the port of said proxy.
  • type: int
  • default:

• acceptSelfSigned

  • If the platform is behind a non trusted certificate, you can disable certificate verification by setting this property to true.
  • type: boolean
  • default: false

• target

  • This is the path where the plugin will look for artifacts to work with.
  • type: string
  • default:

We recommend to use variables for login and password and set them at a global level ($GRADLE_USER_HOME/gradle.properties).