Skip to content
This repository has been archived by the owner on Jul 28, 2023. It is now read-only.

Commit

Permalink
Update the VERSION and README.md files
Browse files Browse the repository at this point in the history
Signed-off-by: Steve Groeger <[email protected]>
  • Loading branch information
groeges committed Oct 18, 2019
1 parent b4b5eae commit aa119d8
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 12 deletions.
45 changes: 34 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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=<registry>
export IMAGE_REGISTRY_USERNAME=<registry_username>
export IMAGE_REGISTRY_PASSWORD=<registry_password>
```

1. Build collections.

Expand Down Expand Up @@ -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`

Expand Down Expand Up @@ -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=<registry>
export IMAGE_REGISTRY_USERNAME=<registry_username>
export IMAGE_REGISTRY_PASSWORD=<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).
Expand Down
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v0.2.0
0.2.0

0 comments on commit aa119d8

Please sign in to comment.