ember-cli-deploy-ovh-object-storage

1.0.0 • Public • Published

ember-cli-deploy-ovh-object-storage

An ember-cli-deploy plugin to upload files to OVH Object Storage

This plugin uploads assets to your static OVH Object Storage container using node-ovh.

Quick Start

To get up and running quickly, do the following:

$ ember install ember-cli-deploy-ovh-object-storage
  • Place the following configuration into config/deploy.js
ENV['ovh-object-storage'] = {
    endpoint: '<ovh-api-endpoint>',
    appKey: '<your-ovh-app-key>',
    appSecret: '<your-ovh-app-secret>',
    consumerKey: '<your-ovh-consumer-key>',
    serviceName: '<your-ovh-cloud-service-id>',
    container: '<your-ovh-cloud-storage-container>',
    region: '<your-ovh-cloud-storage-region>'
}
  • Run the pipeline
$ ember deploy

ember-cli-deploy Hooks Implemented

For detailed information on what plugin hooks are and how they work, please refer to the Plugin Documentation.

  • configure
  • upload

Configuration Options

For detailed information on how configuration of plugins works, please refer to the Plugin Documentation.

endpoint (required)

This property is used by node-ovh plugin which specifies which API you wish to use.

Default: 'undefined'

appKey (required)

Used to identify your OVH Application, please refer to the OVH API Documentation

Default: 'undefined'

appSecret (required)

Used to identify your OVH Application, please refer to the OVH API Documentation

Default: 'undefined'

consumerKey (required)

Your authentication token obtained from OVH, please refer to the OVH API Documentation

Default: 'undefined'

serviceName (required)

Service name is an actual ID of your running OVH Cloud service where the static Object Storage container is used.

Default: 'undefined'

container (required)

Name of your Object Storage container where the assets should be uploaded

Default: 'undefined'

region (required)

Location where your container is hosted

Default: 'undefined'

filePattern

Files that match this pattern will be uploaded. The file pattern must be relative to distDir.

Default: '**/*.{js,css,png,gif,ico,jpg,map,xml,txt,svg,swf,eot,ttf,woff,woff2,otf}'

prefix

A prefix added to the files that the files should be uploaded.

Default: ''

gzipped

If this is set to true, the uploader would try to upload gzippedFiles list to your container.

Default: false

distDir

The root directory where the files matching filePattern will be searched for. By default, this option will use the distDir property of the deployment context, provided by ember-cli-deploy-build.

Default: context.distDir

distFiles

The list of built project files. This option should be relative to distDir and should include the files that match filePattern. By default, this option will use the distFiles property of the deployment context, provided by ember-cli-deploy-build.

Default: context.distFiles

gzippedFiles

The list of files that have been gziped. This option should be relative to distDir. By default, this option will use the gzippedFiles property of the deployment context, provided by ember-cli-deploy-gzip.

This option will be used to determine which files in distDir, that match filePattern, require the gzip content encoding when uploading.

Default: context.gzippedFiles

manifestPath

The path to a manifest that specifies the list of files that are to be uploaded.

This manifest file will be used to work out which files don't exist on your container and, therefore, which files should be uploaded. By default, this option will use the manifestPath property of the deployment context, provided by ember-cli-deploy-manifest.

Default: context.manifestPath

Running Tests

  • npm test

Package Sidebar

Install

npm i ember-cli-deploy-ovh-object-storage

Weekly Downloads

1

Version

1.0.0

License

MIT

Last publish

Collaborators

  • vspasic