Merge pull request #3 from Smarteon/jimi

Introduce s3 and gdrive config

.fixtures.yml

@@ -4,3 +4,4 @@
 fixtures:
   forge_modules:
      archive: "puppet/archive"
+     stdlib: "puppetlabs/stdlib"

README.md

@@ -17,7 +17,15 @@ Depends on following modules:
 ### Beginning with rclone
 ```puppet
 class { 'rclone':
-  version => 'desired rclone version'
+  ensure => 'desired rclone version'
+}
+
+# configure s3
+rclone::config::s3 { 'my_S3':
+  access_key_id     => 'AKI...',
+  secret_access_key => '...',
+  os_user           => 'my_user',
+  region            => 'eu-west-1',
 }
 ```
 

REFERENCE.md

@@ -14,6 +14,12 @@ _Private Classes_
 * `rclone::install`: Ensures Rclone installed
 * `rclone::uninstall`: Removes rclone installed by this module
 
+**Defined types**
+
+* [`rclone::config`](#rcloneconfig): General configuration for Rclone.
+* [`rclone::config::gdrive`](#rcloneconfiggdrive): Google Drive configuration for Rclone.
+* [`rclone::config::s3`](#rcloneconfigs3): S3 configuration for Rclone.
+
 **Functions**
 
 _Public Functions_
@@ -49,5 +55,298 @@ installed version, can be 'latest', 'absent' or valid version string
 
 Default value: 'latest'
 
+## Defined types
+
+### rclone::config
+
+Ensures Rclone configuration of given name, type and params. Include of `rclone` is required.
+
+#### Examples
+
+##### 
+
+```puppet
+rclone::config { 'my_remote':
+  os_user => 'my_user',
+  type    => 'ftp',
+  options => {...}
+}
+```
+
+#### Parameters
+
+The following parameters are available in the `rclone::config` defined type.
+
+##### `ensure`
+
+Data type: `Enum['present', 'absent']`
+
+configuration ensure
+
+Default value: 'present'
+
+##### `os_user`
+
+Data type: `String`
+
+operating system user - used to execute rclone commands, effective configuration owner
+
+##### `type`
+
+Data type: `Enum[
+    'amazon cloud drive',
+    'azureblob',
+    'b2',
+    'box',
+    'crypt',
+    'cache',
+    'chunker',
+    'drive',
+    'dropbox',
+    'fichier',
+    'ftp',
+    'google cloud storage',
+    'google photos',
+    'http',
+    'swift',
+    'hubic',
+    'jottacloud',
+    'koofr',
+    'local',
+    'mailru',
+    'mega',
+    'memory',
+    'onedrive',
+    'opendrive',
+    'pcloud',
+    'premiumizeme',
+    'putio',
+    'qingstor',
+    's3',
+    'sftp',
+    'sharefile',
+    'sugarsync',
+    'union',
+    'webdav',
+    'yandex']`
+
+configuration remote type
+
+##### `options`
+
+Data type: `Hash[String, Optional[String]]`
+
+configuration options - Hash of options for `rclone config` command
+
+##### `config_name`
+
+Data type: `String`
+
+configuration name - should be unique among Rclone configurations, defaults to title
+
+Default value: $title
+
+### rclone::config::gdrive
+
+Ensures Drive Rclone configuration of given name and params. Include of `rclone` is required.
+Support only service account credentials (token authentication requires human interaction when setup).
+
+#### Examples
+
+##### 
+
+```puppet
+rclone::config::gdrive { 'drive_remote':
+  os_user                     => 'my_user',
+  client_id                   => 'SOME_CLIENT_ID',
+  client_secret               => 'SOME_CLIENT_SECRET',
+  service_account_credentials => 'SERVICE_CREDENTIALS',
+}
+```
+
+#### Parameters
+
+The following parameters are available in the `rclone::config::gdrive` defined type.
+
+##### `ensure`
+
+Data type: `Enum['present', 'absent']`
+
+configuration ensure
+
+Default value: 'present'
+
+##### `os_user`
+
+Data type: `String`
+
+operating system user - used to execute rclone commands, effective configuration owner
+
+##### `config_name`
+
+Data type: `String`
+
+configuration name - should be unique among Rclone configurations, defaults to title
+
+Default value: $title
+
+##### `client_id`
+
+Data type: `String`
+
+Google drive client_id, maps to Rclone `client_id` property
+
+##### `client_secret`
+
+Data type: `String`
+
+Google drive client_secret, maps to Rclone `client_secret` property
+
+##### `service_account_credentials`
+
+Data type: `String`
+
+Google drive service_account_credentials, maps to Rclone `service_account_credentials` property
+
+##### `scope`
+
+Data type: `String`
+
+Google drive access scope, maps to Rclone `scope` property
+
+Default value: 'drive'
+
+##### `root_folder_id`
+
+Data type: `Optional[String]`
+
+Id of the drive root folder, maps to Rclone `root_folder_id` property
+
+Default value: `undef`
+
+##### `team_drive`
+
+Data type: `Optional[String]`
+
+Id of the team drive, maps to Rclone `team_drive` property
+
+Default value: `undef`
+
+### rclone::config::s3
+
+Ensures S3 Rclone configuration of given name and params. Include of `rclone` is required.
+Currently only AWS provider is supported.
+
+#### Examples
+
+##### 
+
+```puppet
+rclone::config::s3 { 's3_remote':
+  os_user           => 'my_user',
+  access_key_id     => 'SOME_ACCESS_KEY',
+  secret_access_key => 'SECRET_ACCESS_KEY',
+  region            => 'us-east-1',
+}
+```
+
+#### Parameters
+
+The following parameters are available in the `rclone::config::s3` defined type.
+
+##### `ensure`
+
+Data type: `Enum['present', 'absent']`
+
+configuration ensure
+
+Default value: 'present'
+
+##### `os_user`
+
+Data type: `String`
+
+operating system user - used to execute rclone commands, effective configuration owner
+
+##### `config_name`
+
+Data type: `String`
+
+configuration name - should be unique among Rclone configurations, defaults to title
+
+Default value: $title
+
+##### `access_key_id`
+
+Data type: `String`
+
+S3 provider's access_key_id, maps to Rclone `access_key_id` property
+
+##### `secret_access_key`
+
+Data type: `String`
+
+S3 provider's secret_access_key, maps to Rclone `secret_access_key` property
+
+##### `region`
+
+Data type: `String`
+
+S3 provider's region, maps to Rclone `region` property
+
+##### `s3_provider`
+
+Data type: `Enum['AWS']`
+
+S3 provider, maps to Rclone `provider` property
+
+Default value: 'AWS'
+
+##### `canned_acl`
+
+Data type: `Optional[String]`
+
+S3 canned ACL, maps to Rclone `acl` property
+
+Default value: `undef`
+
+##### `endpoint`
+
+Data type: `Optional[String]`
+
+S3 provider's endpoint, maps to Rclone `endpoint` property
+
+Default value: `undef`
+
+##### `location_constraint`
+
+Data type: `Optional[String]`
+
+S3 location_constraint, maps to Rclone `location_constraint` property
+
+Default value: `undef`
+
+##### `location_constraint`
+
+S3 location_constraint, maps to Rclone `location_constraint` property
+
+Default value: `undef`
+
+##### `server_side_encryption`
+
+Data type: `Optional[String]`
+
+S3 server_side_encryption, maps to Rclone `server_side_encryption` property
+
+Default value: `undef`
+
+##### `storage_class`
+
+Data type: `Optional[String]`
+
+S3 storage_class, maps to Rclone `storage_class` property
+
+Default value: `undef`
+
 ## Functions