From bfacdfc53c2c21836e4032894b4d769be329a3aa Mon Sep 17 00:00:00 2001 From: Andrei Krasnitski Date: Thu, 15 Mar 2018 15:22:33 +0300 Subject: [PATCH] Final release 0.1.0 --- .../jobs/broker-deregistrar/index.yml | 6 + .final_builds/jobs/broker-registrar/index.yml | 6 + .../jobs/postgresql-service-broker/index.yml | 6 + .final_builds/license/index.yml | 6 + .../postgresql-service-broker/index.yml | 6 + LICENSE.md | 201 ++++++++++++++++++ README.md | 72 +++++++ releases/postgresql-service-broker/index.yml | 4 + .../postgresql-service-broker-0.1.0.yml | 38 ++++ 9 files changed, 345 insertions(+) create mode 100644 .final_builds/jobs/broker-deregistrar/index.yml create mode 100644 .final_builds/jobs/broker-registrar/index.yml create mode 100644 .final_builds/jobs/postgresql-service-broker/index.yml create mode 100644 .final_builds/license/index.yml create mode 100644 .final_builds/packages/postgresql-service-broker/index.yml create mode 100644 LICENSE.md create mode 100644 README.md create mode 100644 releases/postgresql-service-broker/index.yml create mode 100644 releases/postgresql-service-broker/postgresql-service-broker-0.1.0.yml diff --git a/.final_builds/jobs/broker-deregistrar/index.yml b/.final_builds/jobs/broker-deregistrar/index.yml new file mode 100644 index 0000000..d04cde0 --- /dev/null +++ b/.final_builds/jobs/broker-deregistrar/index.yml @@ -0,0 +1,6 @@ +builds: + 5e1616f7dd036fa4c178f7f0d0fa13e637b13a87: + version: 5e1616f7dd036fa4c178f7f0d0fa13e637b13a87 + blobstore_id: 658fec67-1d93-4089-671e-a098c85b97da + sha1: abb4ef029db425ed80b50f831fc0ccadbe56c380 +format-version: "2" diff --git a/.final_builds/jobs/broker-registrar/index.yml b/.final_builds/jobs/broker-registrar/index.yml new file mode 100644 index 0000000..15e78c9 --- /dev/null +++ b/.final_builds/jobs/broker-registrar/index.yml @@ -0,0 +1,6 @@ +builds: + ff57ce3ebe34c36270940b9483bfee61b0b9281a: + version: ff57ce3ebe34c36270940b9483bfee61b0b9281a + blobstore_id: 0356e972-d2db-41a8-4cb6-c6eff7090305 + sha1: cd63c0bbb3879cc504c295c28533153920f20ef8 +format-version: "2" diff --git a/.final_builds/jobs/postgresql-service-broker/index.yml b/.final_builds/jobs/postgresql-service-broker/index.yml new file mode 100644 index 0000000..17e1cc9 --- /dev/null +++ b/.final_builds/jobs/postgresql-service-broker/index.yml @@ -0,0 +1,6 @@ +builds: + 6f06b235cd8231edcbab76aa33961c855681cf58: + version: 6f06b235cd8231edcbab76aa33961c855681cf58 + blobstore_id: d787591c-aa68-45ae-7877-0446b87713c6 + sha1: a41e9252a621b6169a145769de7c6ae503b1e132 +format-version: "2" diff --git a/.final_builds/license/index.yml b/.final_builds/license/index.yml new file mode 100644 index 0000000..7e2cf85 --- /dev/null +++ b/.final_builds/license/index.yml @@ -0,0 +1,6 @@ +builds: + a8ff343f3a9cb03adcdc6d75de7a8cf42e01378c: + version: a8ff343f3a9cb03adcdc6d75de7a8cf42e01378c + blobstore_id: fa50de60-a2a9-4f09-5e1d-51c227d3064b + sha1: 1159f728719538b980251cb1e5f0a77661c8387b +format-version: "2" diff --git a/.final_builds/packages/postgresql-service-broker/index.yml b/.final_builds/packages/postgresql-service-broker/index.yml new file mode 100644 index 0000000..4a6edfc --- /dev/null +++ b/.final_builds/packages/postgresql-service-broker/index.yml @@ -0,0 +1,6 @@ +builds: + 4fe9d366fd961518f25e02afda08c315c4458c55: + version: 4fe9d366fd961518f25e02afda08c315c4458c55 + blobstore_id: af6f198b-c02a-4f4c-4af1-832a471c81c6 + sha1: 7269cbc53a6826cc14abb271cd34fbd128e3c04b +format-version: "2" diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..d72e03c --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://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 + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2018 Andrei Krasnitski + + 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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..051d4d6 --- /dev/null +++ b/README.md @@ -0,0 +1,72 @@ +# Cloud Foundry PostgreSQL Service Broker + +This repository contains a BOSH release for a Cloud Foundry PostgreSQL service +broker. + +```shell +git clone https://github.com/Infra-Red/postgresql-service-broker-boshrelease.git ~/workspace/postgresql-service-broker-boshrelease +cd ~/workspace/postgresql-service-broker-boshrelease +git submodule update --init --recursive +``` + +## Dependencies + +- [BOSH CLI v2](https://bosh.io/docs/cli-v2.html#install) +- [BOSH](https://bosh.io/docs/init.html) +- [CF](https://github.com/cloudfoundry/cf-deployment) +- [PostgreSQL](https://github.com/cloudfoundry/postgres-release) + +## Deployment + +Populate a vars file (using `manifest/vars-file.yml` as a template), save it to +`secrets/vars.yml`. You will need values from both your cloud-config and secrets +from your cf-deployment. + +To deploy: + +```shell +bosh upload-stemcell https://s3.amazonaws.com/bosh-aws-light-stemcells/light-bosh-stemcell-3541.9-aws-xen-hvm-ubuntu-trusty-go_agent.tgz +bosh deploy --vars-file secrets/vars.yml manifest/cf-postgres-template.yml +``` + +## Registering the Service Broker + +After registering the service broker, the PostgreSQL service will be visible in the Services Marketplace; using the [CLI](https://github.com/cloudfoundry/cli), run `cf marketplace`. + +### BOSH errand + +``` +$ bosh -e YOUR_ENV -d postgresql-service-broker run-errand broker-registrar +``` + +### Manually + +1. First register the broker using the `cf` CLI. You must be logged in as an admin. + + ``` + $ cf create-service-broker shared-postgresql-broker BROKER_USERNAME BROKER_PASSWORD URL + ``` + + `BROKER_USERNAME` and `BROKER_PASSWORD` are the credentials Cloud Foundry will use to authenticate when making API calls to the service broker. Use the values for manifest properties `jobs.postgresql-service-broker.properties.broker.username` and `jobs.postgresql-service-broker.properties.broker.password`. + + `URL` specifies where the Cloud Controller will access the PostgreSQL broker. Use the IP address of `postgresql-service-broker` instance and port of `postgresql-service-broker` job. By default, port is set to `8080`. + + For more information, see [Managing Service Brokers](http://docs.cloudfoundry.org/services/managing-service-brokers.html). + +2. Then [make the service plan public](http://docs.cloudfoundry.org/services/managing-service-brokers.html#make-plans-public). + +## De-registering the Service Broker + +The following commands are destructive and are intended to be run in conjuction with deleting your BOSH deployment. +``` +$ bosh -e YOUR_ENV -d postgresql-service-broker run-errand broker-deregistrar +``` + +### Manually + +Run the following: + +``` +$ cf purge-service-offering a.postgresql +$ cf delete-service-broker shared-postgresql-broker +``` \ No newline at end of file diff --git a/releases/postgresql-service-broker/index.yml b/releases/postgresql-service-broker/index.yml new file mode 100644 index 0000000..99ce71d --- /dev/null +++ b/releases/postgresql-service-broker/index.yml @@ -0,0 +1,4 @@ +builds: + 91dcfa8f-9f3b-4093-4c12-dc93353be9c3: + version: 0.1.0 +format-version: "2" diff --git a/releases/postgresql-service-broker/postgresql-service-broker-0.1.0.yml b/releases/postgresql-service-broker/postgresql-service-broker-0.1.0.yml new file mode 100644 index 0000000..24d9518 --- /dev/null +++ b/releases/postgresql-service-broker/postgresql-service-broker-0.1.0.yml @@ -0,0 +1,38 @@ +name: postgresql-service-broker +version: 0.1.0 +commit_hash: 1221df8 +uncommitted_changes: true +jobs: +- name: broker-deregistrar + version: 5e1616f7dd036fa4c178f7f0d0fa13e637b13a87 + fingerprint: 5e1616f7dd036fa4c178f7f0d0fa13e637b13a87 + sha1: abb4ef029db425ed80b50f831fc0ccadbe56c380 +- name: broker-registrar + version: ff57ce3ebe34c36270940b9483bfee61b0b9281a + fingerprint: ff57ce3ebe34c36270940b9483bfee61b0b9281a + sha1: cd63c0bbb3879cc504c295c28533153920f20ef8 +- name: postgresql-service-broker + version: 6f06b235cd8231edcbab76aa33961c855681cf58 + fingerprint: 6f06b235cd8231edcbab76aa33961c855681cf58 + sha1: a41e9252a621b6169a145769de7c6ae503b1e132 +packages: +- name: cf-cli-6-linux + version: b501c00e999e27a5354f7ebd06e1e7d061ed0855 + fingerprint: b501c00e999e27a5354f7ebd06e1e7d061ed0855 + sha1: 10e082f726b826ee1da6902993f2de6a3f7c8945 + dependencies: [] +- name: golang-1.10-linux + version: 48c842421b6f05acf88dc6ec17f7574dade28a86 + fingerprint: 48c842421b6f05acf88dc6ec17f7574dade28a86 + sha1: e9a18aebf2c407ce17423c22c913b6612cf4b75f + dependencies: [] +- name: postgresql-service-broker + version: 4fe9d366fd961518f25e02afda08c315c4458c55 + fingerprint: 4fe9d366fd961518f25e02afda08c315c4458c55 + sha1: 7269cbc53a6826cc14abb271cd34fbd128e3c04b + dependencies: + - golang-1.10-linux +license: + version: a8ff343f3a9cb03adcdc6d75de7a8cf42e01378c + fingerprint: a8ff343f3a9cb03adcdc6d75de7a8cf42e01378c + sha1: 1159f728719538b980251cb1e5f0a77661c8387b