Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
flux2
Manage
Activity
Members
Code
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Deploy
Releases
Model registry
Analyze
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
GitHub Mirror
fluxcd
flux2
Commits
9ffe908c
Commit
9ffe908c
authored
4 years ago
by
stefanprodan
Browse files
Options
Downloads
Patches
Plain Diff
Add docs intro
parent
45003436
No related branches found
No related tags found
No related merge requests found
Changes
4
Hide whitespace changes
Inline
Side-by-side
Showing
4 changed files
cmd/tk/bootstrap_gitlab.go
+1
-1
1 addition, 1 deletion
cmd/tk/bootstrap_gitlab.go
docs/get-started/index.md
+14
-10
14 additions, 10 deletions
docs/get-started/index.md
docs/index.md
+16
-1
16 additions, 1 deletion
docs/index.md
mkdocs.yml
+2
-1
2 additions, 1 deletion
mkdocs.yml
with
33 additions
and
13 deletions
cmd/tk/bootstrap_gitlab.go
+
1
−
1
View file @
9ffe908c
...
...
@@ -18,7 +18,7 @@ var bootstrapGitLabCmd = &cobra.Command{
Use
:
"gitlab"
,
Short
:
"Bootstrap GitLab repository"
,
Long
:
`
The bootstrap command creates the Git
Hu
b repository if it doesn't exists and
The bootstrap command creates the Git
La
b repository if it doesn't exists and
commits the toolkit components manifests to the master branch.
Then it configure the target cluster to synchronize with the repository.
If the toolkit components are present on the cluster,
...
...
This diff is collapsed.
Click to expand it.
docs/get-started/index.md
+
14
−
10
View file @
9ffe908c
...
...
@@ -19,11 +19,10 @@ that can create repositories.
To install the latest
`tk`
release run:
```
bash
curl
-s
https:/
fluxcd.github.io/toolkit
/install.sh |
sudo
bash
curl
-s
https:/
/toolkit.fluxcd.io
/install.sh |
sudo
bash
```
The install script downloads the tk binary to
`/usr/local/bin`
.
Binaries for macOS and Linux AMD64 are available for download on the
[
release page
](
https://github.com/fluxcd/toolkit/releases
)
.
...
...
@@ -36,22 +35,23 @@ To configure your shell to load tk completions add to your bash profile:
## Bootstrap
Export your GitHub personal access token with:
You'll be using a dedicated Git repository e.g.
`fleet-infra`
to manage one or more Kubernetes clusters.
First export your GitHub personal access token and GitHub username:
```
sh
export
GITHUB_TOKEN
=
<your-token>
export
GITHUB_USER
=
<your-username>
```
The bootstrap command creates a GitHub repository if one doesn't exist and
commits the toolkit components manifests to the master branch.
Then it configures the target cluster to synchronize with the repository.
If the toolkit components are present on the cluster,
the bootstrap command will perform an upgrade if needed.
The bootstrap command creates a repository if one doesn't exist and
commits the toolkit components manifests to the master branch at the specified path.
Then it configures the target cluster to synchronize with the specified path inside the repository.
```
sh
tk bootstrap github
\
--owner
=
<your-github-username>
\
--repository
=
<repo-name>
\
--owner
=
$GITHUB_USER
\
--repository
=
fleet-infra
\
--path
=
dev-cluster
\
--personal
```
...
...
@@ -107,6 +107,10 @@ deployment "kustomize-controller" successfully rolled out
If you prefer GitLab, export
`GITLAB_TOKEN`
env var and use the command
`tk bootstrap gitlab`
.
It is safe to run the bootstrap command as many times as you want.
If the toolkit components are present on the cluster,
the bootstrap command will perform an upgrade if needed.
## Create a GitOps workflow
Clone the repository with:
...
...
This diff is collapsed.
Click to expand it.
docs/index.md
+
16
−
1
View file @
9ffe908c
# GitOps Toolkit
Experimental toolkit for assembling CD pipelines the GitOps way.
The GitOps Toolkit is a set of composable APIs and specialized tools
that can be used to build a Continuous Delivery platform on top of Kubernetes.
These tools are built with Kubernetes controller-runtime libraries and they
can be dynamically configured with Kubernetes custom resources either by
cluster admins or by other automated tools.
The GitOps Toolkit components interact with each other via Kubernetes
events and are responsible for the reconciliation of their designated API objects.

Components:
-
[
Toolkit CLI
](
https://github.com/fluxcd/toolkit
)
-
[
Source Controller
](
https://github.com/fluxcd/source-controller
)
-
[
Kustomize Controller
](
https://github.com/fluxcd/kustomize-controller
)
To get started with the toolkit please follow this
[
guide
](
get-started/index.md
)
.
This diff is collapsed.
Click to expand it.
mkdocs.yml
+
2
−
1
View file @
9ffe908c
...
...
@@ -35,8 +35,9 @@ markdown_extensions:
-
pymdownx.tabbed
nav
:
-
Introduction
:
index.md
-
Get Started
:
get-started/index.md
-
t
k
CLI
:
-
Toolki
t CLI
:
-
Bootstrap
:
cmd/tk_bootstrap.md
-
Check
:
cmd/tk_check.md
-
Create
:
cmd/tk_create.md
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment