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

build(manifests): quick-start should use cluster-install #12557

Merged
merged 2 commits into from
Feb 17, 2024

Conversation

agilgur5
Copy link

@agilgur5 agilgur5 commented Jan 20, 2024

Follow-ups to #12445 and this related Slack thread

Motivation

  • prior to docs: change quick-start guide to use quick-start install. Fixes #12391 #12445, the quick start docs used the install.yaml instead of the quick-start-minimal.yaml manifests

    • install.yaml is a cluster install, so quick-start-minimal.yaml should also use a cluster install to match the past behavior
  • without the cluster-install, you have to manually navigate to the argo namespace in the UI

    • and you see an error until you do so, which is confusing to new users (per the above linked Slack thread), who are the target audience of the quick start docs
  • the quick start manifests already have fairly broad permissions (in order to get started quickly) and several warnings about not using them in prod, so this usage would be consistent

Modifications

  • use cluster-install instead of namespace-install in the quick start manifests

    • with this usage, we can remove some docs and overlay code from the quick start
      • --namespaced should not be used anymore now that we use a cluster install
      • patching the Argo Server is no longer necessary as the quick-start overlay already contains --auth-mode=server
  • codegen manifests/quick-start*.yaml

  • add manifests/** to codegen on CI's changed-files check

Verification

- prior to bedd47f, the quick start docs used the `install.yaml` instead of the `quick-start-minimal.yaml` manifests
  - `install.yaml` is [a cluster install](https://github.com/argoproj/argo-workflows/blob/df79ce47c467823092a3819495418242984ff13e/Makefile#L419), so `quick-start-minimal.yaml` should also use a cluster install

- without the `cluster-install`, you have to manually navigate to the `argo` namespace in the UI
  - and you see an error until you do so, which is confusing to new users (see also this [Slack thread](https://cloud-native.slack.com/archives/C01QW9QSSSK/p1705544478244329?thread_ts=1705530455.489149&cid=C01QW9QSSSK))

- the quick start manifests already have fairly broad permissions and several warnings about not using them in prod, so this usage would be consistent

- with this usage, we can remove some docs and overlay code from the quick start
  - `--namespaced` should not be used anymore now that we use a cluster install
  - patching the Argo Server is no longer necessary as the quick-start overlay already contains `--auth-mode=server`

Signed-off-by: Anton Gilgur <[email protected]>
@agilgur5 agilgur5 added area/docs Incorrect, missing, or mistakes in docs area/build Build or GithubAction/CI issues labels Jan 20, 2024
- `changed-files` should check for these as well, since they are part of `make codegen`, just not the Swagger portion

Signed-off-by: Anton Gilgur <[email protected]>
@juliev0 juliev0 merged commit 8ebf433 into argoproj:main Feb 17, 2024
29 checks passed
@agilgur5 agilgur5 deleted the build-quick-start-cluster-install branch February 17, 2024 08:06
@agilgur5 agilgur5 added this to the v3.5.x patches milestone May 11, 2024
agilgur5 added a commit that referenced this pull request May 11, 2024
Signed-off-by: Anton Gilgur <[email protected]>
(cherry picked from commit 8ebf433)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/build Build or GithubAction/CI issues area/docs Incorrect, missing, or mistakes in docs area/manifests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants