You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,17 +9,17 @@ We'd love for you to contribute and welcome your help. Here are some guidelines
9
9
10
10
## <aname="issue"></a> Did you find a issue?
11
11
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).
13
13
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.
15
15
16
16
## <aname="submitting"></a> Did you write a patch that fixes a bug?
17
17
18
18
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.
19
19
20
20
Before you submit your pull request consider the following guidelines:
21
21
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
23
23
that relates to your submission. You don't want to duplicate effort.
24
24
25
25
### Submitting a Pull Request
@@ -32,7 +32,7 @@ Fork the project and clone your fork
@@ -108,7 +108,7 @@ That's it! Thank you for your contribution!
108
108
109
109
## <aname="features"></a> **Do you have an ideas for a new feature or a change to an existing one?**
110
110
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.
112
112
113
113
## <aname="questions"></a> Do you have questions about the source code?
# Install a Solace PubSub+ Software Event Broker onto a Kubernetes cluster
4
4
@@ -10,7 +10,7 @@ This project is a best practice template intended for development and demo purpo
10
10
11
11
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.
12
12
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.
14
14
15
15
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:
16
16
@@ -51,7 +51,7 @@ kubectl get nodes
51
51
### 2. Install and configure Helm
52
52
53
53
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).
55
55
56
56
On Linux a simple option to set up the latest stable release is to run:
57
57
@@ -66,7 +66,7 @@ Helm is configured properly if the command `helm version` returns no error.
66
66
67
67
- Add the Solace Helm charts to your local Helm repo:
- 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.
72
72
- 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
97
97
Wait for the deployment to complete following the information printed on the console.
98
98
99
99
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
*[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
*[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)
104
104
105
105
## Contributing
106
106
107
107
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
108
108
109
109
## Authors
110
110
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.
Copy file name to clipboardExpand all lines: docs/PubSubPlusK8SDeployment.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -617,7 +617,7 @@ Check your platform running the `kubectl get nodes` command from your command-li
617
617
#### Install and setup the Helm package manager
618
618
619
619
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).
621
621
622
622
The Helm v3 executable is available from https://github.com/helm/helm/releases . Further documentation is available from https://helm.sh/.
623
623
@@ -638,7 +638,7 @@ The recommended way is to make use of published pre-packaged PubSub+ charts from
638
638
Add or refresh a local Solace `solacecharts` repo:
> 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.
668
668
669
669
### Alternative Deployment with generating templates for the Kubernetes `kubectl` tool
670
670
@@ -679,7 +679,7 @@ Note that later sections of this document about modifying, upgrading or deleting
679
679
2) Add or refresh a local Solace `solacecharts` repo:
0 commit comments