FredHutch/cookbook-objectivefs

Name: cookbook-objectivefs

Owner: Fred Hutchinson Cancer Research Center

Description: A cookbook for managing ObjectiveFS mounts

Created: 2017-11-15 01:27:22.0

Updated: 2017-11-16 22:29:43.0

Pushed: 2017-11-22 18:38:31.0

Homepage:

Size: 24

Language: Ruby

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

objectivefs

Description

This cookbook adds functionality for using ObjectiveFS. ObjectiveFS is:

… a shared distributed POSIX file system that provides persistent data storage among your cloud instances, laptops, containers and office servers.

This cookbook will install the package and allows creation of ObjectiveFS mount points.

Requirements

• Currently only supports Ubuntu 16.04 #FIXME.
• A license for ObjectiveFS is necessary
• The package must be downloaded from ObjectiveFS

Use

The ObjectiveFS requires a license and downloads are behind a login. Thus you must first download and determine another method of distributing this package within your organization.

Package installation in this cookbook (via the default recipe) assumes you have incorporated the package into a local APT repository and will use apt to install a package named objectivefs (the .deb distributed by ObjectiveFS uses this name).

Attributes

• objectivefs['package']
• name: The name of the package to install. Defaults to “objectivefs”
• provider: The Chef package resource provider to use for installation. Defaults to Chef::Provider::Package
• source: Path to the .deb package when using the package provider dpkg_package

Recipes

default

The default recipe simply installs the package. Defaults use apt to install objectivefs

Resources

ofs_mount

ofs_mount will create a mount in the host's fstab. Each mount will have its own configuration directory specified in the env attribute. Currently the instance name is unused by the resource.

Syntax

An ofs_mount resource block creates and manages the configuration directory and mountpoint for an ObjectiveFS file system.

ofs_mount 'test' do
  env '/etc/objectivefs.env'
  aws_access_key_id '1234'
  aws_default_region 'us-west'
  aws_secret_access_key 'abcdefg'
  objectivefs_license 'letmein'
  bucket_uri 's3://foo/bar'
  mount_point '/mnt/ofs_mount_test'
  action :mount
end

Actions

This resource has the following actions:

• :create: creates the configuration directory, populates the configuration files, and creates an entry in the host's file systems table (e.g. fstab).
• :mount: mounts the indicated instance

Properties

• env: The path to the ObjectiveFS configuration directory
• aws_access_key_id: An access key for the S3 bucket
• aws_secret_access_key: The secret access key for the bucket
• aws_default_region: The region containing the s3 bucket
• objectivefs_license: The ObjectiveFS license
• bucket_uri: The S3 URI for the ObjectiveFS bucket
• mount_point: Where the ObjectiveFS bucket will be mounted

Development

An ObjectiveFS package is typically required for development. Download and place the objectivefs package in test/assets/packages and the default recipe will be able to install it in the test-kitchen host.

License, Author, and Trademark Notices

ObjectiveFS

ObjectiveFS Copyright 2013-2017 © Objective Security Corp. All rights reserved.

This Cookbook

Author: Michael Gutteridge (michael.gutteridge@gmail.com) Author: Michael Gutteridge (mrg@fredhutch.org)

This cookbook Copyright © 2017 Fred Hutchinson Cancer Research Center

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.