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

Doc 686 Add initial docs for how to use the Connect Helm chart #89

Merged
merged 10 commits into from
Nov 14, 2024

Conversation

JakeSCahill
Copy link
Contributor

@JakeSCahill JakeSCahill commented Nov 7, 2024

Description

Adds a quickstart to help Kubernetes users:

  1. Discover that a Helm chart exists for Kubernetes deployments.
  2. Learn the basics of how the chart works.
  3. Learn the basics of deploying pipelines in standalone and streams mode.

This is the minimal required documentation to help users get started. Eventually, we will want a complete deployment guide for Kubernetes and we'll need to single-source that guide and all other relevant Connect docs into the Redpanda Self-Managed docs. This is captured in https://redpandadata.atlassian.net/browse/DOC-735

Note: I've explained the strange (known) behavior of CrashLoopBackoffs when pipelines are completed successfully. This needs calling out to reduce the number of related support tickets. We have already had some BYOC customers reporting the issue. I've opened some Jiras to track the resolution of this issue: for Connect and for Connect Helm chart.

Related updates to the values file for the autogenerated docs: redpanda-data/helm-charts#1594

Resolves https://github.com/redpanda-data/documentation-private/issues/2550
Resolves https://github.com/redpanda-data/documentation-private/issues/2775

Review deadline: 12 November

Page previews

Preview

Checks

  • New feature
  • Content gap
  • Support Follow-up
  • Small fix (typos, links, copyedits, etc)

@JakeSCahill JakeSCahill requested a review from a team as a code owner November 7, 2024 10:44
Copy link

netlify bot commented Nov 7, 2024

Deploy Preview for redpanda-connect ready!

Name Link
🔨 Latest commit 7117c38
🔍 Latest deploy log https://app.netlify.com/sites/redpanda-connect/deploys/6735d61188723300088d6025
😎 Deploy Preview https://deploy-preview-89--redpanda-connect.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

+
[source,yaml]
----
config:
Copy link

Choose a reason for hiding this comment

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

I assume this is the example you are referencing that generates input continuously? If so, is there also a way to suggest how folks can create an even more minimal example for their own use?

@david-yu
Copy link

david-yu commented Nov 7, 2024

Could we also include a small section around uninstall and perhaps upgrades of the chart? Similar to how we do things on K8s?

@JakeSCahill
Copy link
Contributor Author

JakeSCahill commented Nov 8, 2024

Could we also include a small section around uninstall and perhaps upgrades of the chart? Similar to how we do things on K8s?

I've added an uninstall section. We'll need a dedicated upgrade guide at some point but I think that should be a separate PR.

+
[source,json,role="no-copy"]
----
{"name":"ZOIE SIPES"}
Copy link
Contributor

Choose a reason for hiding this comment

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

LOL--great names :-)

Copy link
Contributor

@Feediver1 Feediver1 left a comment

Choose a reason for hiding this comment

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

Wow. This is fantastic--clear, intuitive, just wonderful.

Copy link

@david-yu david-yu left a comment

Choose a reason for hiding this comment

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

Looks fantastic! Thank you Jake for this! This goes a long way to getting folks to running RP Connect on K8s.

@JakeSCahill JakeSCahill merged commit bd53bdd into main Nov 14, 2024
5 checks passed
@JakeSCahill JakeSCahill deleted the DOC-686 branch November 14, 2024 16:44
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.

4 participants