Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add nats deployment example #345

Merged
merged 3 commits into from
Jul 6, 2023
Merged

add nats deployment example #345

merged 3 commits into from
Jul 6, 2023

Conversation

wkloucek
Copy link
Contributor

@wkloucek wkloucek commented Jul 3, 2023

Description

add a deployment example on how to deploy oCIS with an external NATS

NOTE: it's currently affected by #322

Related Issue

Motivation and Context

have a working / development / debug example

How Has This Been Tested?

  • run it in minikube

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Technical debt
  • Tests only (no source changes)

Checklist:

  • Code changes
  • Unit tests added
  • Acceptance tests added
  • Documentation generated (make docs) and committed
  • Documentation ticket raised:
  • Documentation PR created:

Comment on lines +1 to +11
# oCIS with NATS deployment example

## Introduction

This example shows how to deploy NATS with NATS as message bus and store.
It will deploy an oCIS instance and NATS, preconfigured to work together.

***Note***: This example is not intended for production use. It is intended to get a working oCIS
with NATS running in Kubernetes as quickly as possible. It is not hardened in any way.

## Getting started
Copy link
Contributor

@mmattel mmattel Jul 5, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# oCIS with NATS deployment example
## Introduction
This example shows how to deploy NATS with NATS as message bus and store.
It will deploy an oCIS instance and NATS, preconfigured to work together.
***Note***: This example is not intended for production use. It is intended to get a working oCIS
with NATS running in Kubernetes as quickly as possible. It is not hardened in any way.
## Getting started
# oCIS with NATS Deployment Example
## Introduction
This example shows how to deploy NATS with NATS as message bus and store.
It will deploy an oCIS instance and NATS, preconfigured to work together.
***Note***: This example is not intended for production use and is not hardened in any way. It is intended as template to get a working oCIS instance running with NATS in Kubernetes as quickly as possible.
## Getting started

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will do this in a subsequent PR, because this feedback can be applied to all deployment examples. Tracker ticket, so it doesn't get lost: #354

Comment on lines +21 to +28
### End result

After following the steps in this guide, you should be able to access the following endpoint, you
may want to add these to your `/etc/hosts` file pointing to your ingress controller IP:

- https://ocis.kube.owncloud.test

Note that if you want to use your own hostname and domain, you will have to change the `externalDomain` value.
Copy link
Contributor

@mmattel mmattel Jul 5, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### End result
After following the steps in this guide, you should be able to access the following endpoint, you
may want to add these to your `/etc/hosts` file pointing to your ingress controller IP:
- https://ocis.kube.owncloud.test
Note that if you want to use your own hostname and domain, you will have to change the `externalDomain` value.
### Final Result
After following the steps in this guide, you should be able to access the following endpoint which you may want to add to your `/etc/hosts` file pointing to your ingress controller IP:
- https://ocis.kube.owncloud.test
Note that if you want to use your own hostname and domain, you will have to change the `externalDomain` value.

...should be able to access the following endpoint...

but where is the endpoint mentioned?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The endpoint is the the url down below, so https://ocis.kube.owncloud.test.

Copy link
Contributor

@mmattel mmattel Jul 6, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

THX, will adapt the suggestion - done.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will do this in a subsequent PR, because this feedback can be applied to all deployment examples. Tracker ticket, so it doesn't get lost: #354

@wkloucek wkloucek mentioned this pull request Jul 5, 2023
Copy link
Contributor

@d7oc d7oc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Comment on lines +21 to +28
### End result

After following the steps in this guide, you should be able to access the following endpoint, you
may want to add these to your `/etc/hosts` file pointing to your ingress controller IP:

- https://ocis.kube.owncloud.test

Note that if you want to use your own hostname and domain, you will have to change the `externalDomain` value.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The endpoint is the the url down below, so https://ocis.kube.owncloud.test.

@wkloucek wkloucek merged commit 1368902 into master Jul 6, 2023
@delete-merged-branch delete-merged-branch bot deleted the nats-deployment-example branch July 6, 2023 07:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants