Skip to content

Commit

Permalink
Link updates (SolaceProducts#71)
Browse files Browse the repository at this point in the history
  • Loading branch information
bczoma authored May 19, 2023
1 parent 9f0f58b commit eca751a
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 16 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/main-branch-only.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Test when pushing to main branch
name: Test deploy

on:
push:
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Solace PubSub+ Event Broker Operator Quick Start
[![Actions Status](https://github.com/SolaceProducts/pubsubplus-kubernetes-operator/actions/workflows/build-test-main.yml/badge.svg?branch=main)](https://github.com/SolaceProducts/pubsubplus-kubernetes-operator/actions?query=workflow%3Abuild+branch%3Amain)
[![Go Report Card](https://goreportcard.com/badge/github.com/solaceproducts/pubsubplus-kubernetes-operator)](https://goreportcard.com/report/github.com/solaceproducts/pubsubplus-kubernetes-operator)
[![Actions Status](https://github.com/SolaceProducts/pubsubplus-kubernetes-quickstart/actions/workflows/main-branch-only.yml/badge.svg?branch=main)](https://github.com/SolaceProducts/pubsubplus-kubernetes-quickstart/actions?query=workflow:test+branch:main)
[![Go Report Card](https://goreportcard.com/badge/github.com/solaceproducts/pubsubplus-kubernetes-quickstart)](https://goreportcard.com/report/github.com/solaceproducts/pubsubplus-kubernetes-quickstart)

The Solace PubSub+ Event Broker Operator (or simply the Operator) is a Kubernetes-native method to install and manage a Solace PubSub+ Software Event Broker on a Kubernetes cluster.

Expand Down Expand Up @@ -254,7 +254,7 @@ Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduc

## Authors

See the list of [contributors](https://github.com/SolaceProducts/pubsubplus-kubernetes-operator/graphs/contributors ) who participated in this project.
See the list of [contributors](https://github.com/SolaceProducts/pubsubplus-kubernetes-quickstart/graphs/contributors ) who participated in this project.

## License

Expand Down

Large diffs are not rendered by default.

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions docs/EventBrokerOperatorUserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The following additional set of documentation is also available:

* For a hands-on quick start, refer to the [Quick Start guide](/README.md).
* For the `PubSubPlusEventBroker` custom resource (deployment configuration, or "broker spec") parameter options, refer to the [PubSub+ Event Broker Operator Parameters Reference](/docs/EventBrokerOperatorParametersReference.md).
* For version-specific information, refer to the [Operator Release Notes](https://github.com/SolaceProducts/pubsubplus-kubernetes-operator/releases)
* For version-specific information, refer to the [Operator Release Notes](https://github.com/SolaceProducts/pubsubplus-kubernetes-quickstart/releases)

This guide is focused on deploying the event broker using the Operator, which is the preferred way to deploy. Note that a [Helm-based deployment](https://github.com/SolaceProducts/pubsubplus-kubernetes-helm-quickstart) is also supported but out of scope for this document.

Expand Down Expand Up @@ -1418,12 +1418,12 @@ The default namespace is `operators` for operators installed from OperatorHub.

#### From Command Line

Use the `deploy.yaml` from the [PubSub+ Event Broker Operator GitHub project](https://github.com/SolaceProducts/pubsubplus-kubernetes-operator). It includes a collection of manifests for all the Kubernetes resources that must be created.
Use the `deploy.yaml` from the [PubSub+ Event Broker Operator GitHub project](https://github.com/SolaceProducts/pubsubplus-kubernetes-quickstart). It includes a collection of manifests for all the Kubernetes resources that must be created.

The following example creates a default deployment. Edit the `deploy.yaml` before applying to customize options:
```sh
# Download manifest for possible edit
wget https://github.com/SolaceProducts/pubsubplus-kubernetes-operator/blob/main/deploy/deploy.yaml
wget https://github.com/SolaceProducts/pubsubplus-kubernetes-quickstart/blob/main/deploy/deploy.yaml
# Edit manifest as required
# Manifest creates a namespace and all K8s resources for the Operator deployment
kubectl apply -f deploy.yaml
Expand Down Expand Up @@ -1487,7 +1487,7 @@ If the Operator has been installed directly from the command line then update `d

OLM automatically manages the CRD and Operator updates.

A direct installation requires taking `deploy.yaml` from the correctly tagged version of the [PubSub+ Event Broker Operator GitHub project](https://github.com/SolaceProducts/pubsubplus-kubernetes-operator), because it includes the corresponding version of the CRD.
A direct installation requires taking `deploy.yaml` from the correctly tagged version of the [PubSub+ Event Broker Operator GitHub project](https://github.com/SolaceProducts/pubsubplus-kubernetes-quickstart), because it includes the corresponding version of the CRD.

>Note: Although the goal is to keep the CRD API versions backwards compatible, it might become necessary to introduce a new API version. In that case, detailed upgrade instructions will be provided in the Release Notes.
Expand Down

0 comments on commit eca751a

Please sign in to comment.