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 CLI bootstrap flux documentation #4136

Merged
merged 6 commits into from
Nov 21, 2023
Merged

Conversation

Samra10
Copy link
Member

@Samra10 Samra10 commented Nov 16, 2023

Closes weaveworks/weave-gitops-enterprise#3619

Documentation Changes

  • Add a new section for bootstrapping flux throw CLI

@Samra10 Samra10 added the documentation Improvements or additions to documentation label Nov 16, 2023
Copy link
Contributor

@enekofb enekofb left a comment

Choose a reason for hiding this comment

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

added some comments and suggestions in #4137

@@ -71,6 +70,9 @@ Please use the following command to start the installation wizard of Weave GitOp
--version="0.35.0" \
--domain-type="localhost" \
--password="admin123"
--repo-url="ssh://git@github.com/my-org-name/my-repo-name"
--branch="main"
--repo-path="clusters/my-cluster"
Copy link
Contributor

Choose a reason for hiding this comment

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

have you tested whether you could bootstrap with this command?

Copy link
Member Author

Choose a reason for hiding this comment

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

yes, I've tested it with the same command and everything went well
image

Copy link
Contributor

Choose a reason for hiding this comment

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

cool, i guess i meant before without the \ that i dont think it would work.

➜✗  gitops bootstrap \                                                                            
    --kubeconfig=$HOME/.kube/config \
    --private-key=$HOME/.ssh/id_rsa \
    --private-key-password="" \
    --version="0.35.0" \
    --domain-type="localhost" \
    --password="admin123" \
    --repo-url="ssh://git@github.com/my-org-name/my-repo-name" \
    --branch="main" \
    --repo-path="clusters/my-cluster"
► creating client to cluster
✔ created client to cluster: https://127.0.0.1:52179
◎ checking flux
► verifying flux installation
✔ flux is installed

7. [Access the dashboard](#access-the-dashboard): via the link from the installation success message.
8. (Optional) [Configure OIDC](#configure-oidc): to enable login to dashboard via OIDC providers.
2. (Optional) [Bootstrap Flux](#bootstrap-flux): bootstrap flux in case flux not found.
3. [Verify Entitlement](#verifying-entitlement): verify the Entitlements secret content (username, password, entitlement).
Copy link
Contributor

Choose a reason for hiding this comment

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

it feels odd that we could be doing a mutation in the cluster like installing flux without first verifying entitlements (given that is a pre-requirement). how do you guys feel about this ( cc @MostafaMegahid @waleedhammam )

Copy link
Contributor

Choose a reason for hiding this comment

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

i think when we discussed it before, there was a dependency as the entitlement lies in flux-system namespace

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes, I mean that given we have verifyXX as step, those seem better to come first before any action, as they are pre-conditions that we need to meet or we would drop. if we are in the scenario of dropping cause pre-condition is not met, you dont want to have done any change in the users environment

  • verifies first then
  • flux
Screenshot 2023-11-21 at 08 18 21

@Samra10 Samra10 requested a review from enekofb November 20, 2023 21:43
Copy link
Contributor

@enekofb enekofb left a comment

Choose a reason for hiding this comment

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

@Samra10
Copy link
Member Author

Samra10 commented Nov 21, 2023

please review the suggestions in the PR https://github.com/weaveworks/weave-gitops/pull/4137/files i could see that flux still not in Capital or typos like

https://github.com/weaveworks/weave-gitops/pull/4136/files#diff-5922e83ea46371417b302651d9cfe4bc0d13b8d2a107e90a114f3531ddfa6220R106

Thanks for the suggestions.

* some suggestion while reading the docs

* some suggestions while reading the docs

* moving from id_rsa to id_ed25519 in examples
@enekofb enekofb self-requested a review November 21, 2023 09:33
Copy link
Contributor

@enekofb enekofb left a comment

Choose a reason for hiding this comment

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

thanks you for adding the docs

@Samra10 Samra10 enabled auto-merge November 21, 2023 18:37
@Samra10 Samra10 merged commit 3ad2955 into main Nov 21, 2023
16 checks passed
@Samra10 Samra10 deleted the 3619-cli-bootstrap-flux-docs branch November 21, 2023 18:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

update user documentation to reflect flux bootstrapping
3 participants