From 66f51274431d78878e8de68e003a2470a7b58616 Mon Sep 17 00:00:00 2001 From: Thomas Leonard Date: Thu, 31 Dec 2020 13:58:45 +0000 Subject: [PATCH] Prepare release --- CHANGES.md | 3 + LICENSE | 191 ++++++++++++++++++++++++++++++++++++++++++ README.md | 25 +++--- current_ocluster.opam | 2 + dune-project | 13 +++ ocluster-api.opam | 1 + ocluster.opam | 10 +++ 7 files changed, 234 insertions(+), 11 deletions(-) create mode 100644 CHANGES.md create mode 100644 LICENSE diff --git a/CHANGES.md b/CHANGES.md new file mode 100644 index 00000000..857c4bd8 --- /dev/null +++ b/CHANGES.md @@ -0,0 +1,3 @@ +### v0.1 + +Initial release. diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..216430d3 --- /dev/null +++ b/LICENSE @@ -0,0 +1,191 @@ + + Apache License + Version 2.0, January 2004 + https://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + Copyright 2020 Thomas Leonard and others + + 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 + + https://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. diff --git a/README.md b/README.md index 212d903a..249f44c4 100644 --- a/README.md +++ b/README.md @@ -34,9 +34,8 @@ The scheduler tries to schedule similar builds on the same machine, to benefit f To install the Git version: ```bash -git clone --recursive https://github.com/ocurrent/ocluster.git +git clone https://github.com/ocurrent/ocluster.git cd ocluster -opam pin add -yn ./obuilder opam pin add -yn . opam depext -i ocluster ``` @@ -213,6 +212,8 @@ ocluster-client -c submission.cap \ --cache-hint tutorial ``` +You will need to start the worker with `--obuilder-store=...` to enable this. + ## Admin The `ocluster-admin` executable can be used to manage the service using `admin.cap`. @@ -289,22 +290,24 @@ For example: The cluster assigns these jobs fair start times of now and now+30s. These will be the next two jobs to run, because their start times are before all of Bob's jobs. -In the `ocluster-admin show` output, you will see these values. -For example: +You can see these values in the `ocluster-admin show` output. For example: ``` ... -queue: (backlog) [bob:job8@10m alice:job1@27s] -clients: alice(5)+2m bob(3) +queue: (backlog) [bob:job9@9m bob:job8@8m bob:job7@7m bob:job6@6m bob:job5@5m + bob:job4@4m bob:job3@3m alice:job1@30s alice:job0@0s] +clients: alice(2)+1m bob(1)+10m ``` This means that: -- There are two jobs on the backlog: Alice's `job1` (fair-start time 27s from now), and Bob's `job8` - (fair start time 10m from now). Alice's job will go first, because it has the lower start time. -- Alice has a rate of 5 jobs (5 job-seconds per second) and her next job will have a fair start time - of 2 minutes from now (because she has already submitted more jobs than her rate). -- Bob has a rate of 3 and no penalty. His next job will get a fair start time of now. +- The backlog contains Bob's remaining 7 jobs, queued up behind Alice's 2 jobs. + `bob:job9@9m` means that Bob's "job9" has a fair start time 9 minutes from now. + Alice's jobs will go next, because they have earlier start times. +- Alice has a rate of 2 jobs (2 job-seconds per second) and her next job will have a fair start time + of 1 minute from now (because she has already submitted 2 minutes of jobs and is expected to + run 2 jobs at once). +- Bob has a rate of 1 and a 10 minute penalty. ## API diff --git a/current_ocluster.opam b/current_ocluster.opam index 465fd5fd..ec51c2e3 100644 --- a/current_ocluster.opam +++ b/current_ocluster.opam @@ -1,6 +1,8 @@ # This file is generated by dune, edit dune-project instead opam-version: "2.0" synopsis: "OCurrent plugin for OCluster builds" +description: + "Creates a stage in an OCurrent pipeline for submitting jobs to OCluster." maintainer: ["talex5@gmail.com"] authors: ["talex5@gmail.com"] homepage: "https://github.com/ocurrent/ocluster" diff --git a/dune-project b/dune-project index d8b38f98..8cbed85d 100644 --- a/dune-project +++ b/dune-project @@ -8,6 +8,8 @@ (package (name ocluster-api) (synopsis "Cap'n Proto API for OCluster") + (description + "OCaml bindings for the OCluster Cap'n Proto API.") (depends ppx_deriving lwt @@ -18,6 +20,16 @@ (package (name ocluster) (synopsis "Distribute build jobs to workers") + (description +"OCluster manages a pool of build workers. +A build scheduler service accepts build jobs from clients and distributes them to worker machines using Cap'n Proto. +Workers register themselves by connecting to the scheduler (and workers do not need to be able to accept incoming network connections). + +The scheduler can manage multiple pools (e.g. `linux-x86_64` and `linux-arm32`). +Clients say which pool should handle their requests. +At the moment, two build types are provided: building a Dockerfile, or building an OBuilder spec. +In either case, the build may done in the context of some Git commit. +The scheduler tries to schedule similar builds on the same machine, to benefit from caching.") (depends prometheus ppx_sexp_conv @@ -46,6 +58,7 @@ (package (name current_ocluster) (synopsis "OCurrent plugin for OCluster builds") + (description "Creates a stage in an OCurrent pipeline for submitting jobs to OCluster.") (depends ppx_deriving (ocluster-api (= :version)) diff --git a/ocluster-api.opam b/ocluster-api.opam index 5935833f..f5d0f628 100644 --- a/ocluster-api.opam +++ b/ocluster-api.opam @@ -1,6 +1,7 @@ # This file is generated by dune, edit dune-project instead opam-version: "2.0" synopsis: "Cap'n Proto API for OCluster" +description: "OCaml bindings for the OCluster Cap'n Proto API." maintainer: ["talex5@gmail.com"] authors: ["talex5@gmail.com"] homepage: "https://github.com/ocurrent/ocluster" diff --git a/ocluster.opam b/ocluster.opam index 903f2640..5ff8e040 100644 --- a/ocluster.opam +++ b/ocluster.opam @@ -1,6 +1,16 @@ # This file is generated by dune, edit dune-project instead opam-version: "2.0" synopsis: "Distribute build jobs to workers" +description: """ +OCluster manages a pool of build workers. +A build scheduler service accepts build jobs from clients and distributes them to worker machines using Cap'n Proto. +Workers register themselves by connecting to the scheduler (and workers do not need to be able to accept incoming network connections). + +The scheduler can manage multiple pools (e.g. `linux-x86_64` and `linux-arm32`). +Clients say which pool should handle their requests. +At the moment, two build types are provided: building a Dockerfile, or building an OBuilder spec. +In either case, the build may done in the context of some Git commit. +The scheduler tries to schedule similar builds on the same machine, to benefit from caching.""" maintainer: ["talex5@gmail.com"] authors: ["talex5@gmail.com"] homepage: "https://github.com/ocurrent/ocluster"