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

Support one-click-demo mode #503

Merged
merged 3 commits into from
Nov 13, 2024
Merged

Support one-click-demo mode #503

merged 3 commits into from
Nov 13, 2024

Conversation

hjkatz
Copy link
Collaborator

@hjkatz hjkatz commented Nov 12, 2024

What

Describe what the change is solving

We would like to support a 1-click installation for marketplace environments.
However, these environments do not allow users to provide required config before 1-click installing.
And, the installation is only successful if the Pod goes Ready (helm install success).
But, our ngrok-op requires user configuration to work, namely API key and authtoken.

So we provide this new oneClickDemoMode: true/false value that can change the behaviour of the installed ngrok-op.

  • When true, ngrok-op will become Ready and log messages about missing required configuration.
  • When false, ngrok-op will run in its normal operator mode (and report errors for missing fields as NotReady, etc...)

How

Describe the solution

Factor out startup functions

Add oneClickDemoMode to helm values.yaml

Breaking Changes

Are there any breaking changes in this PR?
No.

@hjkatz hjkatz requested a review from a team as a code owner November 12, 2024 19:25
@github-actions github-actions bot added area/controller Issues dealing with the controller area/helm-chart Issues dealing with the helm chart labels Nov 12, 2024
Copy link
Collaborator Author

hjkatz commented Nov 12, 2024

@hjkatz hjkatz changed the base branch from main to hkatz/hide-registration November 12, 2024 22:48
Base automatically changed from hkatz/hide-registration to main November 12, 2024 22:48
nameOverride: ""
fullnameOverride: ""
description: "The official ngrok Kubernetes Operator."
commonLabels: {}
commonAnnotations: {}
oneClickDemoMode: false
Copy link
Collaborator

Choose a reason for hiding this comment

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

doesn't this need to be set to true in order for it to work without having to set any required fields? Or do these on click app marketplaces allow specifying a helm value like this by default and its just we can't require user specific values to be set like API crednetials?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Or do these on click app marketplaces allow specifying a helm value like this by default and its just we can't require user specific values to be set like API crednetials?

The latter: My understanding is we can provide a values.yaml but not a pop-up for required fields. So we'll set onClickDemoMode: true in those marketplace values.

Copy link
Collaborator

Choose a reason for hiding this comment

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

ahh ok, thats good to know, thanks

Copy link
Collaborator

Choose a reason for hiding this comment

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

if we can provide default values i'm kinda surprised we didn't just default these installations' replica count to 0 and instruct you to scale up after provider credentials vs a no-op mode, but I don't think I have all the historic context here

Copy link
Collaborator Author

hjkatz commented Nov 13, 2024

Merge activity

  • Nov 13, 11:01 AM EST: A user started a stack merge that includes this pull request via Graphite.
  • Nov 13, 11:01 AM EST: A user merged this pull request with Graphite.

@hjkatz hjkatz merged commit 186c79c into main Nov 13, 2024
9 checks passed
@hjkatz hjkatz deleted the hkatz/one-click-demo branch November 13, 2024 16:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/controller Issues dealing with the controller area/helm-chart Issues dealing with the helm chart
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants