diff --git a/README.md b/README.md index 9a2a8695d..648d6673b 100644 --- a/README.md +++ b/README.md @@ -51,16 +51,6 @@ Click here to find out more about the [Repository structure](https://github.com/ # Whether to build the Codewind Index file export CODEWIND_INDEX=false ``` - These settings are also required to correctly release the collections (if done manually): - ```bash - # Publish images to image registry - export IMAGE_REGISTRY_PUBLISH=false - - # Credentials for publishing images: - export IMAGE_REGISTRY= - export IMAGE_REGISTRY_USERNAME= - export IMAGE_REGISTRY_PASSWORD= - ``` 1. Build collections. @@ -121,7 +111,7 @@ Before creating a final production release for use with your Kabanero installati e.g. https://github.com/kabanero-io/collections/releases/download/v0.2.0.beta2/kabanero-index.yaml 1. Within your Kabanero environment create a sample.yaml based on this sample yaml e.g. https://raw.githubusercontent.com/kabanero-io/kabanero-operator/master/config/samples/full.yaml -1. In the yaml update the URL for the kabanero-index.yaml to tghe one from the release. e.g. +1. In the yaml update the URL for the kabanero-index.yaml to the one from the release. e.g. https://github.com/kabanero-io/collections/releases/download/v0.2.0.beta2/kabanero-index.yaml 1. Save the yaml and then apply it to your Kabanero instance `kubectl apply -f sample.yaml` @@ -151,7 +141,40 @@ This will update the collections and pipelines in your environment. New collecti git push --tags ``` This will trigger another Travis build that will also generate a Git Release and push the images to the image repository. + + NOTE: If you are building locally and are creating a release from the local build then you will need to also perform the following optional steps. + +1. [Optional] Publish built images to an image registry + + If building locally you may want to publish the built images to an image registry. If using Travis to build your release then these should be pushed as part of the Travis build. + + In order to push these images correctly there are some environment variables that will need to be setup: + ```bash + # Publish images to image registry + export IMAGE_REGISTRY_PUBLISH=true + # Credentials for publishing images: + export IMAGE_REGISTRY= + export IMAGE_REGISTRY_USERNAME= + export IMAGE_REGISTRY_PASSWORD= + ``` + Once these environment variable have been set you can publish the images by running a script. + From the base directory, run the release script. For example: + ``` + . ./ci/release.sh + ``` + This will copy files from the ./ci/assets directory to a ./ci/release directory and will then push the built images to the specified image registry. + +1. [Optional] Create a production Git Release + + If building locally and not using Travis, you will need to create a release on a production GIT repository. + + 1. Use these instructions to [create a GIT release manually](https://github.com/kabanero-io/collections/blob/master/create-release.md) using the files in the ./ci/release directory rather than the ./ci/assets directory. + 1. Once all the artifacts are uploaded to the GIT Release, go to the assets inside that release and find the file kabanero-index.yaml and copy its URL for use within your Kabanero instance. + ``` + e.g. https://github.com/kabanero-io/collections/releases/download/v0.2.0.beta2/kabanero-index.yaml . + ``` + ## Need help? If you have a question that you can't find an answer to, we would also like to hear about that too. You can reach out to the community for assistance on the [Kabanero Slack channel](https://ibm-cloud-tech.slack.com/messages/CJZCYTD0Q). diff --git a/VERSION b/VERSION index 1474d00f0..0ea3a944b 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -v0.2.0 +0.2.0 diff --git a/ci/ext/pre_env.d/kabanero_pre_env.sh b/ci/ext/pre_env.d/kabanero_pre_env.sh index 412fdfd9a..7a7bd0bd5 100755 --- a/ci/ext/pre_env.d/kabanero_pre_env.sh +++ b/ci/ext/pre_env.d/kabanero_pre_env.sh @@ -9,7 +9,7 @@ if [ -z $REPO_LIST ]; then export REPO_LIST=incubator fi if [ -z $EXCLUDED_STACKS ]; then - export EXCLUDED_STACKS="incubator/swift incubator/python-flask" + export EXCLUDED_STACKS="" fi if [ -z $CODEWIND_INDEX ]; then export CODEWIND_INDEX=true @@ -21,3 +21,7 @@ if [ -z "$DISPLAY_NAME_PREFIX" ] then export DISPLAY_NAME_PREFIX="Kabanero" fi +if [ -z "$IMAGE_REGISTRY_ORG" ] +then + export IMAGE_REGISTRY_ORG="kabanero" +fi diff --git a/incubator/starter/README.md b/incubator/starter/README.md deleted file mode 100644 index b2c4668a9..000000000 --- a/incubator/starter/README.md +++ /dev/null @@ -1,8 +0,0 @@ -# Starter Stack - -A minimal, runnable starter stack that can be used as a base for developing new stacks. This stack provides a sample application template consisting of single line bash scripts, along with all the settings in Dockerfiles and manifests to allow you to use the Appsody CLI to test out init/run/debug/test/build/deploy ahead of starting to make changes to a copy of this stack for yourself. - -For any new stack, this Readme should explain in detail about this stack and any templates included, e.g.: - -- How can a user start using this stack for application development -- links to getting started guides etc. diff --git a/incubator/starter/image/.dockerignore b/incubator/starter/image/.dockerignore deleted file mode 100644 index 4bc2c7898..000000000 --- a/incubator/starter/image/.dockerignore +++ /dev/null @@ -1,3 +0,0 @@ -**/.git -**/.gitignore -**/.vscode \ No newline at end of file diff --git a/incubator/starter/image/Dockerfile-stack b/incubator/starter/image/Dockerfile-stack deleted file mode 100644 index b02ee3c67..000000000 --- a/incubator/starter/image/Dockerfile-stack +++ /dev/null @@ -1,62 +0,0 @@ -# Dockerfile for building the stack - -FROM registry.access.redhat.com/ubi7/ubi - -# See https://appsody.dev/docs/stacks/environment-variables for more information about each variable. - -# Mount the application directory into the container filesystem, for example -ENV APPSODY_MOUNTS=/:/project/userapp - -# Define a volume for dependencies to be stored between runs, for example -ENV APPSODY_DEPS=/project/deps - -# Directories to watch for changes in -ENV APPSODY_WATCH_DIR=/project/userapp - -# Directories to ignore changes in -ENV APPSODY_WATCH_IGNORE_DIR= - -# Types of file that will trigger a re-launch (change this to be specific to your application). -ENV APPSODY_WATCH_REGEX="^.*.sh$" - -# Optional command executed before RUN/TEST/DEBUG - typically used to install any dependencies from -# the user application -ENV APPSODY_PREP= - -# Configurations for appsody run -# APPSODY_RUN should specify the command to launch your application -# APPSODY_RUN_ON_CHANGE should specify the command to re-launch your application if triggered by a file change -# APPSODY_RUN_KILL Signals whether to kill the server process before starting the APPSODY_RUN_ON_CHANGE action - -ENV APPSODY_RUN="/bin/bash /project/userapp/hello.sh" -ENV APPSODY_RUN_ON_CHANGE=$APPSODY_RUN -ENV APPSODY_RUN_KILL=false - -# Configurations for appsody debug -# APPSODY_DEBUG should specify the command to launch your application in debug mode -# APPSODY_DEBUG_ON_CHANGE should specify the command to re-launch your application in debug mode if triggered by a file change -# APPSODY_DEBUG_KILL Signals whether to kill the server process before starting the APPSODY_DEBUG_ON_CHANGE action - -ENV APPSODY_DEBUG="echo -n \"Debugging \"; /bin/bash /project/userapp/hello.sh" -ENV APPSODY_DEBUG_ON_CHANGE=$APPSODY_DEBUG -ENV APPSODY_DEBUG_KILL=false - -# Configurations for appsody test -# APPSODY_TEST should specify the command to launch your application in test mode -# APPSODY_TEST_ON_CHANGE should specify the command to re-launch your application in test mode if triggered by a file change -# APPSODY_TEST_KILL Signals whether to kill the server process before starting the APPSODY_TEST_ON_CHANGE action - -ENV APPSODY_TEST="/bin/bash /project/userapp/tests/test.sh" -ENV APPSODY_TEST_ON_CHANGE=$APPSODY_TEST -ENV APPSODY_TEST_KILL=false - -# Copy the common components across into your stack filesystem (most stacks will need these) -COPY ./LICENSE /licenses/ -COPY ./project /project -COPY ./config /config - -# Set the working directory to the project directory, which typically contains the stack components and userapp -WORKDIR /project - -# Expose the relevant ports (change this to be specific to your application). -EXPOSE 8080 diff --git a/incubator/starter/image/LICENSE b/incubator/starter/image/LICENSE deleted file mode 100644 index f49a4e16e..000000000 --- a/incubator/starter/image/LICENSE +++ /dev/null @@ -1,201 +0,0 @@ - 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 [yyyy] [name of copyright owner] - - 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. \ No newline at end of file diff --git a/incubator/starter/image/config/app-deploy.yaml b/incubator/starter/image/config/app-deploy.yaml deleted file mode 100644 index 8be828a4f..000000000 --- a/incubator/starter/image/config/app-deploy.yaml +++ /dev/null @@ -1,16 +0,0 @@ -#Configuration file for deploying an appsody project - -#For more information, see: https://github.com/appsody/appsody-operator/blob/master/doc/user-guide.md - -apiVersion: appsody.dev/v1beta1 -kind: AppsodyApplication -metadata: - name: APPSODY_PROJECT_NAME -spec: - version: 1.0.0 - applicationImage: APPSODY_DOCKER_IMAGE - stack: APPSODY_STACK - service: - type: NodePort - port: APPSODY_PORT - expose: true \ No newline at end of file diff --git a/incubator/starter/image/project/.dockerignore b/incubator/starter/image/project/.dockerignore deleted file mode 100644 index 4bc2c7898..000000000 --- a/incubator/starter/image/project/.dockerignore +++ /dev/null @@ -1,3 +0,0 @@ -**/.git -**/.gitignore -**/.vscode \ No newline at end of file diff --git a/incubator/starter/image/project/Dockerfile b/incubator/starter/image/project/Dockerfile deleted file mode 100644 index f58f0101e..000000000 --- a/incubator/starter/image/project/Dockerfile +++ /dev/null @@ -1,13 +0,0 @@ -# Dockerfile for building your application. -# Defines the final image that contains content from both the image and template. - -FROM registry.access.redhat.com/ubi7/ubi - -WORKDIR /project - -COPY . ./ - -EXPOSE 8080 - -# Pass control your application -CMD ["/bin/bash", "/project/userapp/hello.sh"] \ No newline at end of file diff --git a/incubator/starter/stack.yaml b/incubator/starter/stack.yaml deleted file mode 100644 index 5679f7bfe..000000000 --- a/incubator/starter/stack.yaml +++ /dev/null @@ -1,10 +0,0 @@ -name: starter sample runnable stack -version: 0.1.0 -description: starter sample stack that can be run by appsody, to help creation of more stacks -license: Apache-2.0 -language: bash -maintainers: - - name: Henry Nash - email: henry.nash@uk.ibm.com - github-id: henrynash -default-template: simple \ No newline at end of file diff --git a/incubator/starter/templates/simple/.vscode/tasks.json b/incubator/starter/templates/simple/.vscode/tasks.json deleted file mode 100644 index 1f2c9ecd9..000000000 --- a/incubator/starter/templates/simple/.vscode/tasks.json +++ /dev/null @@ -1,47 +0,0 @@ -{ - "version": "2.0.0", - "tasks": [ - { - "label": "Appsody: run", - "type": "shell", - "command": "appsody run", - "group": "build", - "problemMatcher": [] - }, - { - "label": "Appsody: debug", - "type": "shell", - "command": "appsody debug", - "group": "build", - "problemMatcher": [] - }, - { - "label": "Appsody: test", - "type": "shell", - "command": "appsody test", - "group": "test", - "problemMatcher": [] - }, - { - "label": "Appsody: build", - "type": "shell", - "command": "appsody build", - "group": "build", - "problemMatcher": [] - }, - { - "label": "Appsody: deploy", - "type": "shell", - "command": "appsody deploy", - "group": "build", - "problemMatcher": [] - }, - { - "label": "Appsody: stop", - "type": "shell", - "command": "appsody stop", - "group": "build", - "problemMatcher": [] - } - ] -} \ No newline at end of file diff --git a/incubator/starter/templates/simple/hello.sh b/incubator/starter/templates/simple/hello.sh deleted file mode 100644 index f441d9da4..000000000 --- a/incubator/starter/templates/simple/hello.sh +++ /dev/null @@ -1 +0,0 @@ -echo "Hello from Appsody!" \ No newline at end of file diff --git a/incubator/starter/templates/simple/tests/test.sh b/incubator/starter/templates/simple/tests/test.sh deleted file mode 100644 index 8900dcfbd..000000000 --- a/incubator/starter/templates/simple/tests/test.sh +++ /dev/null @@ -1 +0,0 @@ -echo "Running tests for Hello from Appsody!" \ No newline at end of file