From b3c4f18c89ad4919d5475fd3a29e7dcec2bc5987 Mon Sep 17 00:00:00 2001 From: Bassam Tabbara Date: Sat, 5 Nov 2016 17:09:05 -0700 Subject: [PATCH] initial docs and licensing --- CONTRIBUTING.md | 62 +++++++ DCO | 36 ++++ Documentation/build.md | 103 ----------- Documentation/dev-setup.md | 19 -- Documentation/getting-started.md | 125 ------------- Documentation/launch.md | 21 --- Documentation/media/cluster.png | Bin 0 -> 96480 bytes Documentation/media/logo.png | Bin 0 -> 5478 bytes Documentation/publishing.md | 69 ------- LICENSE | 201 +++++++++++++++++++++ Makefile | 14 ++ README.md | 133 +++++++++++++- build/clean | 14 ++ build/common.sh | 14 ++ build/cross-image/Dockerfile | 14 ++ build/cross-image/Makefile | 14 ++ build/cross-image/entrypoint.sh | 14 ++ build/cross-image/rsyncd.sh | 14 ++ build/makelib/cephd.mk | 14 ++ build/makelib/cross.mk | 14 ++ build/makelib/golang.mk | 14 ++ build/makelib/release.mk | 14 ++ build/makelib/toolchain.linux_arm64.cmake | 14 ++ build/run | 14 ++ cmd/rook/block-create.go | 15 ++ cmd/rook/block-create_test.go | 15 ++ cmd/rook/block-list.go | 15 ++ cmd/rook/block-list_test.go | 15 ++ cmd/rook/block-mount.go | 15 ++ cmd/rook/block-mount_test.go | 15 ++ cmd/rook/block-unmount.go | 15 ++ cmd/rook/block-unmount_test.go | 15 ++ cmd/rook/block.go | 15 ++ cmd/rook/node-list.go | 15 ++ cmd/rook/node-list_test.go | 15 ++ cmd/rook/node.go | 15 ++ cmd/rook/pool-create.go | 15 ++ cmd/rook/pool-create_test.go | 15 ++ cmd/rook/pool-list.go | 15 ++ cmd/rook/pool-list_test.go | 15 ++ cmd/rook/pool.go | 15 ++ cmd/rook/rook.go | 15 ++ cmd/rook/status.go | 15 ++ cmd/rook/status_test.go | 15 ++ cmd/rookd/daemon.go | 15 ++ cmd/rookd/main.go | 15 ++ cmd/rookd/version.go | 16 ++ demo/vagrant/Vagrantfile | 14 ++ demo/vagrant/util.rb | 14 ++ main.go | 15 ++ pkg/api/device.go | 15 ++ pkg/api/handlers.go | 15 ++ pkg/api/handlers_test.go | 15 ++ pkg/api/image.go | 15 ++ pkg/api/logger.go | 15 ++ pkg/api/node.go | 15 ++ pkg/api/pool.go | 15 ++ pkg/api/router.go | 15 ++ pkg/api/routes.go | 15 ++ pkg/api/status.go | 15 ++ pkg/api/status_test.go | 15 ++ pkg/cephmgr/ceph.go | 15 ++ pkg/cephmgr/cephd/cephd.go | 15 ++ pkg/cephmgr/cephleader.go | 15 ++ pkg/cephmgr/cephleader_test.go | 15 ++ pkg/cephmgr/client/auth.go | 15 ++ pkg/cephmgr/client/connection.go | 15 ++ pkg/cephmgr/client/erasure-code-profile.go | 15 ++ pkg/cephmgr/client/image.go | 15 ++ pkg/cephmgr/client/iocontext.go | 15 ++ pkg/cephmgr/client/mon.go | 15 ++ pkg/cephmgr/client/pool.go | 15 ++ pkg/cephmgr/client/status.go | 15 ++ pkg/cephmgr/client/status_test.go | 15 ++ pkg/cephmgr/client/test/connection.go | 15 ++ pkg/cephmgr/client/test/image.go | 15 ++ pkg/cephmgr/client/test/iocontext.go | 15 ++ pkg/cephmgr/config.go | 15 ++ pkg/cephmgr/config_test.go | 15 ++ pkg/cephmgr/conn.go | 15 ++ pkg/cephmgr/conn_test.go | 15 ++ pkg/cephmgr/mon.go | 15 ++ pkg/cephmgr/monagent.go | 15 ++ pkg/cephmgr/monagent_test.go | 15 ++ pkg/cephmgr/monleader.go | 15 ++ pkg/cephmgr/monleader_test.go | 15 ++ pkg/cephmgr/osd.go | 15 ++ pkg/cephmgr/osd_test.go | 15 ++ pkg/cephmgr/osdagent.go | 15 ++ pkg/cephmgr/osdagent_test.go | 15 ++ pkg/cephmgr/osdleader.go | 15 ++ pkg/cephmgr/partition/scheme.go | 15 ++ pkg/cephmgr/partition/scheme_test.go | 15 ++ pkg/cephmgr/test/conn.go | 15 ++ pkg/clusterd/agent.go | 15 ++ pkg/clusterd/clusterMember.go | 15 ++ pkg/clusterd/clusterMember_test.go | 15 ++ pkg/clusterd/clusterservice.go | 15 ++ pkg/clusterd/health.go | 15 ++ pkg/clusterd/inventory/disk.go | 15 ++ pkg/clusterd/inventory/hardware.go | 15 ++ pkg/clusterd/inventory/inventory.go | 15 ++ pkg/clusterd/inventory/node.go | 15 ++ pkg/clusterd/inventory/node_test.go | 15 ++ pkg/clusterd/join.go | 15 ++ pkg/clusterd/lease.go | 15 ++ pkg/clusterd/refresh.go | 15 ++ pkg/clusterd/refresh_test.go | 15 ++ pkg/clusterd/servicesleader.go | 15 ++ pkg/clusterd/servicesleader_test.go | 15 ++ pkg/clusterd/status.go | 15 ++ pkg/clusterd/trigger.go | 15 ++ pkg/etcdmgr/agent.go | 15 ++ pkg/etcdmgr/agent_test.go | 15 ++ pkg/etcdmgr/bootstrap/client.go | 15 ++ pkg/etcdmgr/bootstrap/config.go | 15 ++ pkg/etcdmgr/bootstrap/context.go | 15 ++ pkg/etcdmgr/bootstrap/discovery.go | 15 ++ pkg/etcdmgr/bootstrap/etcd.go | 15 ++ pkg/etcdmgr/etcdmgr.go | 15 ++ pkg/etcdmgr/leader.go | 15 ++ pkg/etcdmgr/leader_test.go | 15 ++ pkg/etcdmgr/member.go | 15 ++ pkg/etcdmgr/policy/policy.go | 15 ++ pkg/etcdmgr/test/mocketcdmgr.go | 15 ++ pkg/model/block-image.go | 15 ++ pkg/model/node.go | 15 ++ pkg/model/pool.go | 15 ++ pkg/model/status.go | 15 ++ pkg/rook/client/block.go | 15 ++ pkg/rook/client/client.go | 15 ++ pkg/rook/client/client_test.go | 15 ++ pkg/rook/client/node.go | 15 ++ pkg/rook/client/pool.go | 15 ++ pkg/rook/client/status.go | 15 ++ pkg/rook/test/mockclient.go | 15 ++ pkg/util/display/bytes.go | 15 ++ pkg/util/display/bytes_test.go | 15 ++ pkg/util/display/numbers.go | 15 ++ pkg/util/display/numbers_test.go | 15 ++ pkg/util/exec/error.go | 15 ++ pkg/util/exec/exec.go | 15 ++ pkg/util/exec/test/mockexec.go | 15 ++ pkg/util/file.go | 15 ++ pkg/util/flags/flags.go | 15 ++ pkg/util/flags/flags_test.go | 15 ++ pkg/util/id.go | 15 ++ pkg/util/id_test.go | 15 ++ pkg/util/kmod/kmod.go | 15 ++ pkg/util/mocketcd.go | 15 ++ pkg/util/mocketcd_test.go | 15 ++ pkg/util/proc/monitoredproc.go | 15 ++ pkg/util/proc/monitoredproc_test.go | 15 ++ pkg/util/proc/process_unix.go | 16 ++ pkg/util/proc/procmanager.go | 15 ++ pkg/util/set.go | 15 ++ pkg/util/set_test.go | 15 ++ pkg/util/store.go | 15 ++ pkg/util/store_test.go | 15 ++ pkg/util/sys/device.go | 15 ++ pkg/util/sys/device_test.go | 15 ++ pkg/version/version.go | 15 ++ scripts/clean-rookd.sh | 13 ++ 163 files changed, 2696 insertions(+), 338 deletions(-) create mode 100644 CONTRIBUTING.md create mode 100644 DCO delete mode 100644 Documentation/build.md delete mode 100644 Documentation/dev-setup.md delete mode 100644 Documentation/getting-started.md delete mode 100644 Documentation/launch.md create mode 100644 Documentation/media/cluster.png create mode 100644 Documentation/media/logo.png delete mode 100644 Documentation/publishing.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000000..d97f3d898b64 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,62 @@ +## How to Contribute + +The Rook project in under [Apache 2.0 license](LICENSE). We accept contributions via +GitHub pull requests. This document outlines some of the conventions related to +development workflow, commit message formatting, contact points and other +resources to make it easier to get your contribution accepted. + +## Certificate of Origin + +By contributing to this project you agree to the Developer Certificate of +Origin (DCO). This document was created by the Linux Kernel community and is a +simple statement that you, as a contributor, have the legal right to make the +contribution. See the [DCO](DCO) file for details. + +## Getting Started + +- Fork the repository on GitHub +- Read the [README](README.md) for build and test instructions +- Play with the project, submit bugs, submit patches! + +## Contribution Flow + +This is a rough outline of what a contributor's workflow looks like: + +- Create a branch from where you want to base your work (usually master). +- Make your changes and arrange them in readable commits. +- Make sure your commit messages are in the proper format (see below). +- Push your changes to the branch in your fork of the repository. +- Make sure all tests pass, and add any new tests as appropriate. +- Submit a pull request to the original repository. + +## Coding Style + +Rook projects are written in golang and follows the style guidelines dictated by +the go fmt as well as go vet tools. + +## Commit Messages + +We follow a rough convention for commit messages that is designed to answer two +questions: what changed and why. The subject line should feature the what and +the body of the commit should describe the why. + +``` +cephmgr: update MON to use rocksdb + +this enables us to remove leveldb from the codebase. +``` + +The format can be described more formally as follows: + +``` +: + + + +