Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/syberalexis/puppet-storj
This module automates the install of Storj components.
https://github.com/syberalexis/puppet-storj
puppet puppet-forge storj
Last synced: 9 days ago
JSON representation
This module automates the install of Storj components.
- Host: GitHub
- URL: https://github.com/syberalexis/puppet-storj
- Owner: syberalexis
- License: apache-2.0
- Created: 2020-04-08T10:14:40.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-04-12T16:25:40.000Z (over 4 years ago)
- Last Synced: 2024-04-19T11:03:28.627Z (6 months ago)
- Topics: puppet, puppet-forge, storj
- Language: Ruby
- Homepage: https://forge.puppet.com/maeq/storj
- Size: 44.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# maeq-storj
[](https://travis-ci.com/syberalexis/puppet-storj)
[](https://forge.puppetlabs.com/maeq/storj)
[](https://forge.puppetlabs.com/maeq/storj)
[](https://forge.puppetlabs.com/maeq/storj)
[](LICENSE)
#### Table of Contents
- [Description](#description)
- [Usage](#usage)
- [Examples](#examples)
- [Limitations](#limitations)
- [Development](#development)
## Description
This module automates the install of [Storj](https://storj.io/) and it's components.
## Usage
For more information see [REFERENCE.md](REFERENCE.md).
### Before running
#### Request your authorization token
Before all things, you need to request your authorization token to each node [HERE](https://storj.io/sign-up-node-operator/).
#### Create identity key
You need to create a identity key. This operation take many time and this module don't manage it.
Refer to the documentation https://documentation.storj.io/dependencies/identity#create-an-identity
### Install Storj
#### Puppet
```puppet
class { 'storj':
authorization_token => '[YOUR AUTHORIZATION TOKEN]',
wallet => '[YOUR WALLET ADDRESS]',
mail => '[YOUR EMAIL]',
host => '[THE NODE HOSTNAME OR ALTNAME]',
storage => '[THE DEDICATED ANOUT OF STORAGE]',
storage_path => '[THE DEDICATED STORAGE LOCATION]',
}
```
#### Hiera Data
```puppet
include storj
```
```yaml
storj::authorization_token: '[YOUR AUTHORIZATION TOKEN]'
storj::wallet: '[YOUR WALLET ADDRESS]'
storj::mail: '[YOUR EMAIL]'
storj::host: '[THE NODE HOSTNAME OR ALTNAME]'
storj::storage: '[THE DEDICATED ANOUT OF STORAGE]'
storj::storage_path: '[THE DEDICATED STORAGE LOCATION]'
```
## Examples
#### Default installation
```yaml
storj::authorization_token: '[email protected]:T3sT'
storj::wallet: '0x00000000000000000000'
storj::mail: '[email protected]'
storj::host: 'my_storj_storagenode'
storj::storage: '1TB'
storj::storage_path: '/dev/sdb1'
```
#### Personal docker installation
```yaml
storj::authorization_token: '[email protected]:T3sT'
storj::wallet: '0x00000000000000000000'
storj::mail: '[email protected]'
storj::host: 'my_storj_storagenode'
storj::storage: '1TB'
storj::storage_path: '/dev/sdb1'
storj::manage_docker: false
```
## Limitations
This module don't create the identity key. Please see [documentation](https://documentation.storj.io/dependencies/identity#create-an-identity)
## Development
This project contains tests for [rspec-puppet](http://rspec-puppet.com/).
Quickstart to run all linter and unit tests:
```bash
bundle install --path .vendor/
bundle exec rake test
```