Skip to content

Commit 194ad0b

Browse files
authored
Updates from rename of the repo to pubsubplus-kubernetes-helm-quickstart (#122)
1 parent 3282cd1 commit 194ad0b

File tree

8 files changed

+41
-41
lines changed

8 files changed

+41
-41
lines changed

.github/workflows/build-test.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -156,16 +156,16 @@ jobs:
156156
mkdir gh-pages; # Now update gh-pages
157157
if [ ${{ github.ref }} == 'refs/heads/master' ] && [ ${{ github.repository_owner }} == 'SolaceProducts' ] ; then
158158
echo "Using master on SolaceProducts"
159-
git clone --quiet --branch=gh-pages https://${{ secrets.GH_TOKEN }}@github.com/SolaceProducts/pubsubplus-kubernetes-quickstart gh-pages > /dev/null 2>&1
159+
git clone --quiet --branch=gh-pages https://${{ secrets.GH_TOKEN }}@github.com/SolaceProducts/pubsubplus-kubernetes-helm-quickstart gh-pages > /dev/null 2>&1
160160
rm -rf gh-pages/helm-charts-openshift; mkdir -p gh-pages/helm-charts-openshift
161161
mv pubsubplus-openshift-*.tgz gh-pages/helm-charts-openshift/
162-
helm repo index gh-pages/helm-charts-openshift/ --url https://solaceproducts.github.io/pubsubplus-kubernetes-quickstart/helm-charts-openshift
162+
helm repo index gh-pages/helm-charts-openshift/ --url https://solaceproducts.github.io/pubsubplus-kubernetes-helm-quickstart/helm-charts-openshift
163163
mv pubsubplus-*.tgz gh-pages/helm-charts/
164-
helm repo index gh-pages/helm-charts/ --url https://solaceproducts.github.io/pubsubplus-kubernetes-quickstart/helm-charts
164+
helm repo index gh-pages/helm-charts/ --url https://solaceproducts.github.io/pubsubplus-kubernetes-helm-quickstart/helm-charts
165165
pushd gh-pages
166166
git add -f .
167167
git commit -m "Latest helm chart updates on successful gha-test build ${{ github.run_number }} auto-pushed to gh-pages"
168-
git remote add origin-pages https://${{ secrets.GH_TOKEN }}@github.com/SolaceProducts/pubsubplus-kubernetes-quickstart.git > /dev/null 2>&1
168+
git remote add origin-pages https://${{ secrets.GH_TOKEN }}@github.com/SolaceProducts/pubsubplus-kubernetes-helm-quickstart.git > /dev/null 2>&1
169169
git push --quiet --set-upstream origin-pages gh-pages
170170
popd
171171
echo "Updated and pushed GH pages!"
@@ -174,9 +174,9 @@ jobs:
174174
git clone --quiet --branch=gh-pages https://${{ secrets.GH_TOKEN }}@github.com/${{ github.repository }} gh-pages > /dev/null 2>&1
175175
rm -rf gh-pages/helm-charts-openshift; mkdir -p gh-pages/helm-charts-openshift
176176
mv pubsubplus-openshift-*.tgz gh-pages/helm-charts-openshift/
177-
helm repo index gh-pages/helm-charts-openshift/ --url https://solacedev.github.io/pubsubplus-kubernetes-quickstart/helm-charts-openshift
177+
helm repo index gh-pages/helm-charts-openshift/ --url https://solacedev.github.io/pubsubplus-kubernetes-helm-quickstart/helm-charts-openshift
178178
mv pubsubplus-*.tgz gh-pages/helm-charts/
179-
helm repo index gh-pages/helm-charts/ --url https://solacedev.github.io/pubsubplus-kubernetes-quickstart/helm-charts
179+
helm repo index gh-pages/helm-charts/ --url https://solacedev.github.io/pubsubplus-kubernetes-helm-quickstart/helm-charts
180180
pushd gh-pages
181181
git add -f .
182182
git commit -m "Latest helm chart updates on successful gha-test build ${{ github.run_number }} auto-pushed to gh-pages"

CONTRIBUTING.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,17 @@ We'd love for you to contribute and welcome your help. Here are some guidelines
99

1010
## <a name="issue"></a> Did you find a issue?
1111

12-
- **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/SolaceProducts/pubsubplus-kubernetes-quickstart/issues).
12+
- **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/SolaceProducts/pubsubplus-kubernetes-helm-quickstart/issues).
1313

14-
- If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/SolaceProducts/pubsubplus-kubernetes-quickstart/issues). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
14+
- If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/SolaceProducts/pubsubplus-kubernetes-helm-quickstart/issues). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
1515

1616
## <a name="submitting"></a> Did you write a patch that fixes a bug?
1717

1818
Open a new GitHub pull request with the patch following the steps outlined below. Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
1919

2020
Before you submit your pull request consider the following guidelines:
2121

22-
- Search [GitHub](/https://github.com/SolaceProducts/pubsubplus-kubernetes-quickstart/pulls) for an open or closed Pull Request
22+
- Search [GitHub](/https://github.com/SolaceProducts/pubsubplus-kubernetes-helm-quickstart/pulls) for an open or closed Pull Request
2323
that relates to your submission. You don't want to duplicate effort.
2424

2525
### Submitting a Pull Request
@@ -32,7 +32,7 @@ Fork the project and clone your fork
3232
locally.
3333

3434
```sh
35-
prompt:~$ git clone https://github.com/SolaceProducts/pubsubplus-kubernetes-quickstart
35+
prompt:~$ git clone https://github.com/SolaceProducts/pubsubplus-kubernetes-helm-quickstart
3636
```
3737

3838
#### Step 2: Branch
@@ -61,7 +61,7 @@ repository.
6161
If you have not set the upstream, do so as follows:
6262

6363
```sh
64-
prompt:~$ git remote add upstream https://github.com/SolaceProducts/pubsubplus-kubernetes-quickstart
64+
prompt:~$ git remote add upstream https://github.com/SolaceProducts/pubsubplus-kubernetes-helm-quickstart
6565
```
6666

6767
then:
@@ -108,7 +108,7 @@ That's it! Thank you for your contribution!
108108

109109
## <a name="features"></a> **Do you have an ideas for a new feature or a change to an existing one?**
110110

111-
- Open a GitHub [enhancement request issue](https://github.com/SolaceProducts/pubsubplus-kubernetes-quickstart/issues) and describe the new functionality.
111+
- Open a GitHub [enhancement request issue](https://github.com/SolaceProducts/pubsubplus-kubernetes-helm-quickstart/issues) and describe the new functionality.
112112

113113
## <a name="questions"></a> Do you have questions about the source code?
114114

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[![Actions Status](https://github.com/SolaceProducts/pubsubplus-kubernetes-quickstart/workflows/build/badge.svg?branch=master)](https://github.com/SolaceProducts/pubsubplus-kubernetes-quickstart/actions?query=workflow%3Abuild+branch%3Amaster)
1+
[![Actions Status](https://github.com/SolaceProducts/pubsubplus-kubernetes-helm-quickstart/workflows/build/badge.svg?branch=master)](https://github.com/SolaceProducts/pubsubplus-kubernetes-helm-quickstart/actions?query=workflow%3Abuild+branch%3Amaster)
22

33
# Install a Solace PubSub+ Software Event Broker onto a Kubernetes cluster
44

@@ -10,7 +10,7 @@ This project is a best practice template intended for development and demo purpo
1010

1111
This document provides a quick getting started guide to install a software event broker in various configurations onto a [Kubernetes](https://kubernetes.io/docs/home/) cluster.
1212

13-
Detailed documentation is provided in the [Solace PubSub+ Software Event Broker on Kubernetes Documentation](docs/PubSubPlusK8SDeployment.md). Consult the [Deployment Coonsiderations](https://github.com/SolaceProducts/pubsubplus-kubernetes-quickstart/blob/master/docs/PubSubPlusK8SDeployment.md#pubsub-event-broker-deployment-considerations) section of the Documentation when planning your deployment.
13+
Detailed documentation is provided in the [Solace PubSub+ Software Event Broker on Kubernetes Documentation](docs/PubSubPlusK8SDeployment.md). Consult the [Deployment Coonsiderations](https://github.com/SolaceProducts/pubsubplus-kubernetes-helm-quickstart/blob/master/docs/PubSubPlusK8SDeployment.md#pubsub-event-broker-deployment-considerations) section of the Documentation when planning your deployment.
1414

1515
This document is applicable to any platform supporting Kubernetes, with specific hints on how to set up a simple MiniKube deployment on a Linux-based machine. To view examples of other Kubernetes platforms see:
1616

@@ -51,7 +51,7 @@ kubectl get nodes
5151
### 2. Install and configure Helm
5252

5353
Follow the [Helm Installation notes of your target release](https://github.com/helm/helm/releases) for your platform.
54-
Note: Helm v2 is no longer supported. For Helm v2 support refer to [earlier versions of the chart](https://github.com/SolaceProducts/pubsubplus-kubernetes-quickstart/releases).
54+
Note: Helm v2 is no longer supported. For Helm v2 support refer to [earlier versions of the chart](https://github.com/SolaceProducts/pubsubplus-kubernetes-helm-quickstart/releases).
5555

5656
On Linux a simple option to set up the latest stable release is to run:
5757

@@ -66,7 +66,7 @@ Helm is configured properly if the command `helm version` returns no error.
6666

6767
- Add the Solace Helm charts to your local Helm repo:
6868
```bash
69-
helm repo add solacecharts https://solaceproducts.github.io/pubsubplus-kubernetes-quickstart/helm-charts
69+
helm repo add solacecharts https://solaceproducts.github.io/pubsubplus-kubernetes-helm-quickstart/helm-charts
7070
```
7171
- By default the publicly available [latest Docker image of PubSub+ Software Event Broker Standard Edition](https://hub.Docker.com/r/solace/solace-pubsub-standard/tags/) will be used. Specify a different image or [use a Docker image from a private registry](/docs/PubSubPlusK8SDeployment.md#using-private-registries) if required. If using a non-default image, add the `--set image.repository=<your-image-location>,image.tag=<your-image-tag>` values to the commands below.
7272
- Generally, for configuration options and ways to override default configuration values (using `--set` is one the options), consult the [PubSub+ Software Event Broker Helm Chart Reference](/pubsubplus/README.md#configuration).
@@ -97,18 +97,18 @@ The above options will start the deployment and write related information and no
9797
Wait for the deployment to complete following the information printed on the console.
9898

9999
Refer to the detailed PubSub+ Kubernetes documentation for:
100-
* [Validating the deployment](//github.com/SolaceProducts/pubsubplus-kubernetes-quickstart/blob/master/docs/PubSubPlusK8SDeployment.md#validating-the-deployment); or
101-
* [Troubleshooting](//github.com/SolaceProducts/pubsubplus-kubernetes-quickstart/blob/master/docs/PubSubPlusK8SDeployment.md#troubleshooting)
102-
* [Modifying or Upgrading](//github.com/SolaceProducts/pubsubplus-kubernetes-quickstart/blob/master/docs/PubSubPlusK8SDeployment.md#modifying-or-upgrading-a-deployment)
103-
* [Deleting the deployment](//github.com/SolaceProducts/pubsubplus-kubernetes-quickstart/blob/master/docs/PubSubPlusK8SDeployment.md#deleting-a-deployment)
100+
* [Validating the deployment](//github.com/SolaceProducts/pubsubplus-kubernetes-helm-quickstart/blob/master/docs/PubSubPlusK8SDeployment.md#validating-the-deployment); or
101+
* [Troubleshooting](//github.com/SolaceProducts/pubsubplus-kubernetes-helm-quickstart/blob/master/docs/PubSubPlusK8SDeployment.md#troubleshooting)
102+
* [Modifying or Upgrading](//github.com/SolaceProducts/pubsubplus-kubernetes-helm-quickstart/blob/master/docs/PubSubPlusK8SDeployment.md#modifying-or-upgrading-a-deployment)
103+
* [Deleting the deployment](//github.com/SolaceProducts/pubsubplus-kubernetes-helm-quickstart/blob/master/docs/PubSubPlusK8SDeployment.md#deleting-a-deployment)
104104

105105
## Contributing
106106

107107
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
108108

109109
## Authors
110110

111-
See the list of [contributors](//github.com/SolaceProducts/pubsubplus-kubernetes-quickstart/graphs/contributors) who participated in this project.
111+
See the list of [contributors](//github.com/SolaceProducts/pubsubplus-kubernetes-helm-quickstart/graphs/contributors) who participated in this project.
112112

113113
## License
114114

docs/PubSubPlusK8SDeployment.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -617,7 +617,7 @@ Check your platform running the `kubectl get nodes` command from your command-li
617617
#### Install and setup the Helm package manager
618618

619619
The event broker can be deployed using Helm v3.
620-
> Note: For Helm v2 support refer to [earlier versions of this quickstart](https://github.com/SolaceProducts/pubsubplus-kubernetes-quickstart/releases).
620+
> Note: For Helm v2 support refer to [earlier versions of this quickstart](https://github.com/SolaceProducts/pubsubplus-kubernetes-helm-quickstart/releases).
621621
622622
The Helm v3 executable is available from https://github.com/helm/helm/releases . Further documentation is available from https://helm.sh/.
623623

@@ -638,7 +638,7 @@ The recommended way is to make use of published pre-packaged PubSub+ charts from
638638
Add or refresh a local Solace `solacecharts` repo:
639639
```bash
640640
# Add new "solacecharts" repo
641-
helm repo add solacecharts https://solaceproducts.github.io/pubsubplus-kubernetes-quickstart/helm-charts
641+
helm repo add solacecharts https://solaceproducts.github.io/pubsubplus-kubernetes-helm-quickstart/helm-charts
642642
# Refresh if needed, e.g.: to use a recently published chart version
643643
helm repo update solacecharts
644644

@@ -664,7 +664,7 @@ helm fetch solacecharts/pubsubplus --untar
664664
# Use the Helm chart from this directory
665665
helm install ./pubsubplus
666666
```
667-
> Note: it is encouraged to raise a [GitHub issue](https://github.com/SolaceProducts/pubsubplus-kubernetes-quickstart/issues/new) to possibly contribute your enhancements back to the project.
667+
> Note: it is encouraged to raise a [GitHub issue](https://github.com/SolaceProducts/pubsubplus-kubernetes-helm-quickstart/issues/new) to possibly contribute your enhancements back to the project.
668668
669669
### Alternative Deployment with generating templates for the Kubernetes `kubectl` tool
670670

@@ -679,7 +679,7 @@ Note that later sections of this document about modifying, upgrading or deleting
679679
2) Add or refresh a local Solace `solacecharts` repo:
680680
```bash
681681
# Add new "solacecharts" repo
682-
helm repo add solacecharts https://solaceproducts.github.io/pubsubplus-kubernetes-quickstart/helm-charts
682+
helm repo add solacecharts https://solaceproducts.github.io/pubsubplus-kubernetes-helm-quickstart/helm-charts
683683
# Refresh if needed, e.g.: to use a recently published chart version
684684
helm repo update solacecharts
685685
```

docs/helm-charts/test-chart-variants-from-gh-pages.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ helm init --wait --service-account=tiller --upgrade # this may take some time
5555
helm version
5656

5757
# test charts
58-
helm repo add solacecharts https://solaceproducts.github.io/pubsubplus-kubernetes-quickstart/helm-charts
58+
helm repo add solacecharts https://solaceproducts.github.io/pubsubplus-kubernetes-helm-quickstart/helm-charts
5959
helm repo list
6060

6161
testDeployHelmv2 pubsubplus-dev
@@ -74,7 +74,7 @@ curl https://raw.githubusercontent.com/helm/helm/master/scripts/get-helm-3 | bas
7474
helm version
7575

7676
# test charts
77-
helm repo add solacecharts https://solaceproducts.github.io/pubsubplus-kubernetes-quickstart/helm-charts
77+
helm repo add solacecharts https://solaceproducts.github.io/pubsubplus-kubernetes-helm-quickstart/helm-charts
7878
helm repo list
7979

8080
testDeployHelmv3 pubsubplus-dev

pubsubplus/Chart.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ apiVersion: v2
22
description: Deploy Solace PubSub+ Event Broker Singleton or HA redundancy group onto a Kubernetes Cluster
33
name: pubsubplus
44
version: 3.2.0
5-
icon: https://solaceproducts.github.io/pubsubplus-kubernetes-quickstart/images/PubSubPlus.png
5+
icon: https://solaceproducts.github.io/pubsubplus-kubernetes-helm-quickstart/images/PubSubPlus.png
66
kubeVersion: '>= 1.10.0-0'
77
maintainers:
88
- name: Solace Community Forum
@@ -11,7 +11,7 @@ maintainers:
1111
url: https://solace.com/support/
1212
home: https://dev.solace.com
1313
sources:
14-
- https://github.com/SolaceProducts/pubsubplus-kubernetes-quickstart
14+
- https://github.com/SolaceProducts/pubsubplus-kubernetes-helm-quickstart
1515
keywords:
1616
- solace
1717
- pubsubplus

0 commit comments

Comments
 (0)