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
GitLab community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
GitHub Mirror
fluxcd
flux2
Commits
2d2b24f5
Unverified
Commit
2d2b24f5
authored
4 years ago
by
Hidde Beydals
Committed by
GitHub
4 years ago
Browse files
Options
Downloads
Plain Diff
Merge pull request #239 from fluxcd/readme-update
docs: add more content to the README.md
parents
67e0acd0
346d8f75
Branches
Branches containing commit
Tags
Tags containing commit
No related merge requests found
Changes
3
Show whitespace changes
Inline
Side-by-side
Showing
3 changed files
README.md
+62
-3
62 additions, 3 deletions
README.md
docs/index.md
+3
-3
3 additions, 3 deletions
docs/index.md
docs/roadmap/index.md
+1
-1
1 addition, 1 deletion
docs/roadmap/index.md
with
66 additions
and
7 deletions
README.md
+
62
−
3
View file @
2d2b24f5
...
...
@@ -5,8 +5,67 @@
[

](https://github.com/fluxcd/toolkit/blob/master/LICENSE)
[

](https://github.com/fluxcd/toolkit/releases)
Experimental toolkit for assembling CD pipelines the GitOps way.

To get started with the toolkit please read the
[
docs
](
https://toolkit.fluxcd.io/
)
.
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 build 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.
## `gotk` installation
With Homebrew:
```
sh
brew tap fluxcd/tap
brew
install
gotk
```
With Bash:
```
sh
curl
-s
https://toolkit.fluxcd.io/install.sh |
sudo
bash
# enable completions in ~/.bash_profile
.
<
(
gotk completion
)
```
Binaries for macOS and Linux AMD64/ARM64 are available to download on the
[
release page
](
https://github.com/fluxcd/toolkit/releases
)
.
Verify that your cluster satisfies the prerequisites with:
```
sh
gotk check
--pre
```
## Get started
To get started with the GitOps Toolkit, start
[
browsing the documentation
](
https://toolkit.fluxcd.io
)
or get started with one of the following guides:
-
[
Get started with GitOps Toolkit (deep dive)
](
https://toolkit.fluxcd.io/get-started/
)
-
[
Installation
](
https://toolkit.fluxcd.io/guides/installation/
)
-
[
Manage Helm Releases
](
https://toolkit.fluxcd.io/guides/helmreleases/
)
-
[
Setup Notifications
](
https://toolkit.fluxcd.io/guides/notifications/
)
-
[
Setup Webhook Receivers
](
https://toolkit.fluxcd.io/guides/webhook-receivers/
)
## Components
-
[
Toolkit CLI
](
https://toolkit.fluxcd.io/cmd/gotk/
)
-
[
Source Controller
](
https://toolkit.fluxcd.io/components/source/controller/
)
-
[
GitRepository CRD
](
https://toolkit.fluxcd.io/components/source/gitrepositories/
)
-
[
HelmRepository CRD
](
https://toolkit.fluxcd.io/components/source/helmrepositories/
)
-
[
HelmChart CRD
](
https://toolkit.fluxcd.io/components/source/helmcharts/
)
-
[
Kustomize Controller
](
https://toolkit.fluxcd.io/components/kustomize/controller/
)
-
[
Kustomization CRD
](
https://toolkit.fluxcd.io/components/kustomize/kustomization/
)
-
[
Helm Controller
](
https://toolkit.fluxcd.io/components/helm/controller/
)
-
[
HelmRelease CRD
](
https://toolkit.fluxcd.io/components/helm/helmreleases/
)
-
[
Notification Controller
](
https://toolkit.fluxcd.io/components/notification/controller/
)
-
[
Provider CRD
](
https://toolkit.fluxcd.io/components/notification/provider/
)
-
[
Alert CRD
](
https://toolkit.fluxcd.io/components/notification/alert/
)
-
[
Receiver CRD
](
https://toolkit.fluxcd.io/components/notification/receiver/
)
This diff is collapsed.
Click to expand it.
docs/index.md
+
3
−
3
View file @
2d2b24f5
...
...
@@ -3,7 +3,7 @@
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 buil
t
with Kubernetes controller-runtime libraries and they
These tools are buil
d
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
...
...
@@ -13,7 +13,7 @@ events and are responsible for the reconciliation of their designated API object
We envision a future where
**Flux v2**
and
**Helm Operator v2**
will be assembled from
the GitOps Toolkit components. The Flux CD team is looking for feedback and help as
the toolkit is in an active experimentation phase.
If you wish to take part in this quest please reach out to us on Slack
and
GitHub.
If you wish to take part in this quest please reach out to us on Slack
or
GitHub.

...
...
This diff is collapsed.
Click to expand it.
docs/roadmap/index.md
+
1
−
1
View file @
2d2b24f5
...
...
@@ -91,6 +91,6 @@ Tasks
-
[x]
<span
style=
"color:grey"
>
Implement support for values from
`Secret`
and
`ConfigMap`
resources
</span>
-
[x]
<span
style=
"color:grey"
>
Implement conditional remediation on (failed) Helm actions
</span>
-
[x]
<span
style=
"color:grey"
>
Implement support for Helm charts from Git
</span>
-
[x]
<span
style=
"color:grey"
>
Implement support for referring to an alternative chart values file
</span>
\
-
[x]
<span
style=
"color:grey"
>
Implement support for referring to an alternative chart values file
</span>
-
[ ] Stabilize API
-
[ ] Create a migration guide for Helm Operator users
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