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

Split the installation section & add the bootstrap sub section #1568

Closed
wants to merge 33 commits into from

Conversation

mehak151
Copy link
Collaborator

Made the following structural changes as per: #1560

Installation

  • index (Prerequisites, CLI install, install options: explain flux bootstrap vs terraform flux_bootstrap_git vs flux install)
  • Bootstrap
    -- index (empty, will just list all options below)
    -- Generic Git Server
    -- GitHub
    -- GitLab
    -- BitBucket
    -- AWS CodeCommit
    -- Azure DevOps
    -- Google Cloud Source
  • Upgrade (CLI bootstrap, GH Action, Renovate, terraform, in-cluster)
  • Uninstall (CLI uninstall)

Remove the following sections to be included in the Bootstrap section later as per fluxcd#1560

Generic Git Server
GitHub
GitLab
BitBucket
AWS CodeCommit
Azure DevOps
Google Cloud Source

Signed-off-by: mehak151 <[email protected]>
Signed-off-by: mehak151 <[email protected]>
Need to create one in installation folder instead

Signed-off-by: mehak151 <[email protected]>
Signed-off-by: mehak151 <[email protected]>
Signed-off-by: mehak151 <[email protected]>
Signed-off-by: mehak151 <[email protected]>
Added redirects for following:


Bootstrap
Generic Git Server
GitHub
GitLab
BitBucket
AWS CodeCommit
Azure DevOps
Google Cloud Source
Upgrade
Uninstall

Signed-off-by: mehak151 <[email protected]>
Comment on lines +7 to +8
This guide walks you through setting up Flux to
manage one or more Kubernetes clusters.
Copy link
Member

Choose a reason for hiding this comment

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

This is no longer a guide style doc. Can you please write here an introduction and explain what Flux is made of, and give a quick overview of what people should expect from this doc.

content/en/flux/installation/_index.md Outdated Show resolved Hide resolved
Comment on lines +111 to +118
If your Git provider is **AWS CodeCommit**, **Azure DevOps**, **Bitbucket Server**, **GitHub** or **GitLab** please
follow the specific bootstrap procedure:

* [AWS CodeCommit](./bootstrap/aws-code-commit.md#flux-installation-for-aws-codecommit)
* [Azure DevOps](./bootstrap/azure.md#flux-installation-for-azure-devops)
* [Bitbucket Server and Data Center](./bootstrap/bitbucket.md#bitbucket-server-and-data-center)
* [GitHub.com and GitHub Enterprise](./bootstrap/github.md#github-and-github-enterprise)
* [GitLab.com and GitLab Enterprise](./bootstrap/gitlab.md#gitlab-and-gitlab-enterprise)
Copy link
Member

Choose a reason for hiding this comment

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

We need to list here all the options with Generic Git server first, also no need to repeat the provider names in bold.

Using the `flux bootstrap` command you can install Flux on a
Kubernetes cluster and configure it to manage itself from a Git
repository.

Copy link
Member

Choose a reason for hiding this comment

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

Here we need a short example, you could use the bootstrap git with a private SSH key so we avoid talking about SSH agent here.

content/en/flux/installation/_index.md Show resolved Hide resolved
content/en/flux/installation/bootstrap/aws-code-commit.md Outdated Show resolved Hide resolved
content/en/flux/installation/bootstrap/github.md Outdated Show resolved Hide resolved
content/en/flux/installation/bootstrap/github.md Outdated Show resolved Hide resolved
content/en/flux/installation/upgrade.md Outdated Show resolved Hide resolved
mehak151 and others added 7 commits July 19, 2023 07:40
Co-authored-by: Stefan Prodan <[email protected]>
Signed-off-by: mehak151 <[email protected]>
Co-authored-by: Stefan Prodan <[email protected]>
Signed-off-by: mehak151 <[email protected]>
Co-authored-by: Stefan Prodan <[email protected]>
Signed-off-by: mehak151 <[email protected]>
Co-authored-by: Stefan Prodan <[email protected]>
Signed-off-by: mehak151 <[email protected]>
Co-authored-by: Stefan Prodan <[email protected]>
Signed-off-by: mehak151 <[email protected]>
Co-authored-by: Stefan Prodan <[email protected]>
Signed-off-by: mehak151 <[email protected]>
@stefanprodan
Copy link
Member

@mehak151 please fix Error: error building site: assemble: /opt/build/repo/content/en/flux/installation/bootstrap/generic-git-server.md:2:1: failed to unmarshal YAML: yaml: line 2: did not find expected key

@mehak151
Copy link
Collaborator Author

Fixed

@stefanprodan
Copy link
Member

@mehak151 please see #1573, this one can be closed

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.

2 participants