Commit Graph

383 Commits (efb7a27a3ab7dda4d3a2d35c1a725df2c6db6318)

Author SHA1 Message Date
Kingdon Barrett efb7a27a3a capitalize Jsonnet in some places
Just the bare minimum add new text to explain the change to kubecfg

This PR should be reopened as the `jsonnet-gutted` branch, with
commentary removed and slimmed down to just code examples with as little
non-embedded commentary as possible.

This way we can consider reorganizing any pieces that would need to be
redone for example in a hypothetical Jenkins+cdk8s use case document, or
something else like Gitlab+Tanka, or Tekton+kubecfg, or any combination.

If we are going to document outside solutions and proper integrations
with them, then we should probably make their treatments as equal as
possible to avoid showing favoritism.
4 years ago
Kingdon Barrett d68991f514 decide on a home for the jsonnet
"release-manifests.yaml" workflow which targets releasing tags that are
labeled as a release, or commits that are pushed on the release branch.

add more detail in jsonnet example section

more text

There might be some overlap with the SOPS/Azure KMS example that Leigh
provided

re-align with #1064

fixup text

substantial rework in introduction

more text that hasn't been in a commit yet

more organization

more commentary
4 years ago
Kingdon Barrett f4d6f8947c Manifest Gen: GitHub Actions use case example
* Fixme: Jsonnet is still missing an example.jsonnet

If you test these examples now then you will find

...the example for build doesn't expect or honor any caching, while
there is an easy opportunity to add caching...

Some additional things that need changes to fix them to work
better, or adding more caveats in the tutorial text...

* clarify that "this is CI-ops"

Jsonnet will be 2 examples now, 1- how to copy a configmap in several
repos, 2- how to copy a secret in several repos (the sops/gitops way)
4 years ago
Stefan Prodan b54fd2c6b3
Add source namespace to create commands
Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>
4 years ago
Leon Kiefer fd1c038303
Updated automation migration guide filter tags crd
Signed-off-by: Leon Kiefer <leon.k97@gmx.de>
4 years ago
Daniel Holbach 32f94bab97 fix links
- change links in cli docs to be relative (making mkdocs AND hugo happy)
	- run 'make docs'
	- fix other links

Signed-off-by: Daniel Holbach <daniel@weave.works>
4 years ago
Hidde Beydals 236ffd1767 Tidy up command descriptions
Rewordings and removal of superfluous newlines.

Signed-off-by: Hidde Beydals <hello@hidde.co>
4 years ago
Hidde Beydals 4750d0d81c Allow supplying PK from file for Git source/secret
This commit adds support for supplying a path to an existing private
key file to both the `flux create secret git` and `flux create source
git` commands.

If a path is given, any private key generation configuration options
are ignored by the manifest generator. The SSH host will however still
be scanned for server keys.

Signed-off-by: Hidde Beydals <hello@hidde.co>
4 years ago
Leon Kiefer 974f01cb46
fix crd deletion command in v2 migration docs
Signed-off-by: Leon Kiefer <leon.k97@gmx.de>
4 years ago
Stefan Prodan 9deab1c415
Update dev guide to controller-runtime v0.8
Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>
4 years ago
Hidde Beydals 998f0c7d53 Add frontmatter to command documentation
Signed-off-by: Hidde Beydals <hello@hidde.co>
4 years ago
Kingdon Barrett f17801753d
Fixup a broken reference and a typo in Azure doc
Signed-off-by: Kingdon Barrett <kingdon@weave.works>
4 years ago
Jim Stallings aa122455f7 Remove branch switch for image update cmd in guide
Signed-off-by: James Stallings <jstallings@constantcontact.com>
4 years ago
Stefan Prodan 968f249562
Move GOTK diagram to docs/files
Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>
4 years ago
Stefan Prodan bb9f476be2
Fix typo in image automation guide
Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>
4 years ago
Stefan Prodan 276f43fdeb
Add AWS IAM role binding example to SOPS guide
Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>
4 years ago
leigh capili 1bf3814701
Cleanup note sections
Signed-off-by: leigh capili <leigh@null.net>
4 years ago
leigh capili 166181c745
Add Azure Use-Case doc to new section
Signed-off-by: leigh capili <leigh@null.net>
4 years ago
leigh capili bfff977d41
Improve Azure DevOps install notes
Signed-off-by: leigh capili <leigh@null.net>
4 years ago
leigh capili 787d755261
Document Flux + SOPS + Azure Key Vault (#851)
Signed-off-by: leigh capili <leigh@null.net>
4 years ago
Stefan Prodan 10ff99542f
Add image update automation diagram
Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>
4 years ago
Stefan Prodan 2449030ab8
Add push branch and commit template to image automation guide
Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>
4 years ago
Stefan Prodan 73b1576f81
Implement get all for sources and images
Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>
4 years ago
Stefan Prodan d9331b0c91 Add repo path and push branch to image update cmd
Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>
4 years ago
Stefan Prodan b6a8163dd9 Add create image policy examples
Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>
4 years ago
Stefan Prodan 185252ba48 Update flux logs examples
Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>
4 years ago
Joe Bowbeer 02fb8d9958
Merge branch 'main' into patch-1 4 years ago
Joe Bowbeer 85fbb780bf Update image-update.md
The filename is podinfo-deployment.yaml

Signed-off-by: Joe Bowbeer <joe.bowbeer@gmail.com>
4 years ago
Somtochi Onyekwere 6d2e34e9b2 Add flux logs command
Signed-off-by: Somtochi Onyekwere <somtochionyekwere@gmail.com>
4 years ago
Kingdon Barrett 4cf5290989
fixup hint in Flux v1 Migration guide
The wrong indenting means the hint body will not display as a hint

Signed-off-by: Kingdon Barrett <kingdon@weave.works>
4 years ago
Scott Rigby b775d11a70
Flux Migration and Support Timetable
* Set explicit column widths for timetable

  No need for old Firefox workaround. It appears fine on FF in 2021

  See:
  - https://github.com/squidfunk/mkdocs-material/issues/922
  - https://github.com/squidfunk/mkdocs-material/issues/118

* Hide TOC right column on migration table page

* SDK->GOTK footnote

* Cross-link admonitions between Roadmap and Timetable

  To-do: change structure and file names under migration menu dir when we
  move to fluxcd/website

* Add custom heart admonition

* Link to documentated deprecation of apiextensions.k8s.io/v1beta1
  CustomResourceDefinition

* Fix caret (^^ underlines short status)

* Initial migration and Support Timetable

  Add mkdocs markdown_extensions and sort them alphabetically

Co-authored-by: Stefan Prodan <stefan.prodan@gmail.com>
Signed-off-by: Scott Rigby <scott@r6by.com>
4 years ago
Lucas Servén Marín 065d0b2c06
cmd/flux/export_source*: fix typo in comment
This commit fixes a small typo in the comments for the export source
commands.

Signed-off-by: Lucas Servén Marín <lserven@gmail.com>
4 years ago
leigh capili d2cdd02a57
Parameterize GPG key input and fingerprint
Signed-off-by: leigh capili <leigh@null.net>
4 years ago
leigh capili 095c8323a1
Capitalize SOPS, K8s, and Git
Signed-off-by: leigh capili <leigh@null.net>
4 years ago
leigh capili accb4c915e
Improve SOPS GPG guide key management
- Switch to batch GPG key creation
- Accurately name the cluster's decryption key
- Suggest password-manager backup
- Optionally cleanup secret key from generating machine
- Optionally commit the public key to the repo for team members
- Document SOPS limitations decryption required for editing / appending fields

Signed-off-by: leigh capili <leigh@null.net>
4 years ago
Hidde Beydals c4907cf6c6 docs: fix link to source-controller documentation
Signed-off-by: Hidde Beydals <hello@hidde.co>
4 years ago
Hidde Beydals ed93e93b81 Restore default key algorithm flag create source
This was removed by accident in the PR that introduced the new
`manifestgen` packages, and now restored in full glory.

Signed-off-by: Hidde Beydals <hello@hidde.co>
4 years ago
leigh capili ebf9188c6a
Fix anchor on kustomize migration link
Signed-off-by: leigh capili <leigh@null.net>
4 years ago
Stefan Prodan 384c60a988
Move the v1 vs v2 FAQ to the migration section
Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>
4 years ago
Stefan Prodan 309b9b52f8 Add Helm Controller standalone FAQ to migration guide
Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>
4 years ago
Stefan Prodan 5d063e7390 faq: Can I use Flux HelmReleases without GitOps?
Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>
4 years ago
tvories d9eabcdbf7 Removed posix style loading for flux and added .fish filetype to completions file
Signed-off-by: tvories <taylor@tmtech.me>
4 years ago
Hidde Beydals 8a5bba80bf Add `sourcesecret` and `kustomization` manifestgen
This includes a change to the `sync` generator to make the deploy
secret name configurable.

Signed-off-by: Hidde Beydals <hello@hidde.co>
4 years ago
Stefan Prodan 45ba845f23
Document air-gapped install procedure
Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>
4 years ago
Stefan Prodan 6003d11156
Embed the install manifests in flux binary
- add make target for generating the install manifests using kustomize
- embed the generated manifests in flux binary
- the install and bootstrap commands default to using the embedded manifests
- download the install manifests from GitHub only if the install/bootstrap version arg is set

Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>
4 years ago
Patrick Ruckstuhl 433492791b Add example podMonitor for prometheus
Signed-off-by: Patrick Ruckstuhl <patrick@ch.tario.org>
4 years ago
Hidde Beydals a6538b117e Add notes about flux bootstrap and feature parity
Signed-off-by: Hidde Beydals <hello@hidde.co>
4 years ago
leigh capili b5027d8f3f Use git remote-base instead of zip-archive for cloud image-update example
Signed-off-by: leigh capili <leigh@null.net>
4 years ago
Stefan Prodan 771fc20bb2
Add production ready and GA sections to roadmap
Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>
4 years ago
Hidde Beydals 1b5db157b1 Align formatting and extensions workflows
Signed-off-by: Hidde Beydals <hello@hidde.co>
4 years ago