Commit Graph

35 Commits

Author SHA1 Message Date
Matheus Pimenta 3d434f0fe7
[RFC-0010] Link workload identity docs to complete guide
Signed-off-by: Matheus Pimenta <matheuscscp@gmail.com>
2025-05-26 23:50:06 +01:00
Dipti Pai f03a53d73e [RFC-007] Implement GitHub app authentication for git repositories in IAC
- Controller change to use the GitHub authentication information specified in Git Repository's `.spec.secretRef` to create the auth options to authenticate to git repositories when the `provider` field is set to `github`,
- Tests for new `github` provider field in IAC
- Updated docs to use GitHub Apps for authentication in image-automation-controller.

Signed-off-by: Dipti Pai <diptipai89@outlook.com>
2025-02-13 10:38:31 -08:00
Kevin McDermott 189ba5894b Add documented example.
Signed-off-by: Kevin McDermott <bigkevmcd@gmail.com>
2024-10-28 10:38:31 +00:00
Dipti Pai b24fb414c3 Enable Azure OIDC for Azure DevOps Repository in IAC
- Controller changes to set the provider options in git authOptions to fetch provider credentials while building git config if `.spec.provider` field is set to `azure`.

- API docs for setting up Azure workload identity in IAC

- Unit tests for testing provider settings in git  config

Signed-off-by: Dipti Pai <diptipai89@outlook.com>
2024-09-25 22:07:44 +00:00
Maxim Samoilov d0a24940d6 Add support to limit applied policies in automation by specifying a selector
Signed-off-by: Maxim Samoilov <nitive@icloud.com>
2024-04-18 16:37:12 +05:30
Sunny fd4a40d941 Add v1beta2 API spec docs
Signed-off-by: Sunny <github@darkowlzz.space>
2024-04-18 16:37:06 +05:30
Kingdon Barrett 8f451b85cd
Fix bad link
Signed-off-by: Kingdon Barrett <kingdon@weave.works>
2023-08-29 21:27:16 -04:00
Sanskar Jaiswal 1dd0e63924
add support for specifying push options
Add `.spec.git.push.options` to allow specifying the push options to be
sent to the upstream Git server during a push operation. For more info,
see: https://git-scm.com/docs/git-push#Documentation/git-push.txt---push-optionltoptiongt

This is useful for platforms like GitLab when used with
image-automation-controller by enabling the creation of MRs automatically
upon a push operation (ref: https://docs.gitlab.com/ee/user/project/push_options.html#push-options-for-merge-requests)

Signed-off-by: Sanskar Jaiswal <jaiswalsanskar078@gmail.com>
2023-08-23 20:48:09 +05:30
Sanskar Jaiswal f7c5f690a7
git: add docs for usage with Gerrit
Signed-off-by: Sanskar Jaiswal <jaiswalsanskar078@gmail.com>
2023-08-23 17:39:41 +05:30
Sanskar Jaiswal 192b9e006b
git: add docs for `push.refspec`
Signed-off-by: Sanskar Jaiswal <jaiswalsanskar078@gmail.com>
2023-08-23 17:39:41 +05:30
Kingdon Barrett 491c2cb59d
Fix links in API docs
Signed-off-by: Kingdon Barrett <kingdon@weave.works>
2023-08-22 07:15:13 -04:00
Max Jonas Werner cea79ca764
Align docs structure with other controllers
In some controller we already support multiple API versions at the
same time. In order to streamline the docs structure, the necessary
changes to do the same in this repo are applied here as well.

refs fluxcd/website#1577

Signed-off-by: Max Jonas Werner <mail@makk.es>
2023-07-21 17:09:39 +02:00
Hidde Beydals 7cc9c9c5f4 Rename controllers to controller
Signed-off-by: Hidde Beydals <hidde@hhh.computer>
2023-05-25 10:08:03 +02:00
Sanskar Jaiswal cf455f2e34
add support for commit sigining PGP key passphrases
Add support for decrypting the private key of the commit signing PGP
key. The secret specified in `spec.commit.signingKey.secretRef` can now
optionally have a `passphrase` key where it's value is the password to
be used for decryptin the private key.

Signed-off-by: Sanskar Jaiswal <jaiswalsanskar078@gmail.com>
2023-05-02 19:31:06 +05:30
Paulo Gomes b396dce1c6
libgit2: Update documentation
Signed-off-by: Paulo Gomes <paulo.gomes@weave.works>
2022-12-09 13:43:22 +00:00
Paulo Gomes 5475da4475
Document GitShallowClone and GitForcePushBranch#
Signed-off-by: Paulo Gomes <paulo.gomes@weave.works>
2022-12-06 15:37:16 +00:00
Daniel Holbach 2d581b6e8b update to new doc links structure
Signed-off-by: Daniel Holbach <daniel@weave.works>
2022-08-30 15:24:16 +02:00
Daniel Holbach 1a2033675f update toolkit.f.i docs links
Signed-off-by: Daniel Holbach <daniel@weave.works>
2022-04-01 10:29:36 +02:00
Somtochi Onyekwere 0ca01bd254 Add flag to disable cross-namespace referencing
Signed-off-by: Somtochi Onyekwere <somtochionyekwere@gmail.com>
2022-01-28 08:32:21 +01:00
Soule BA bc3d7b2112 Add support for the sprig functions library
All functions are not supported, The following are discarded:
            // Date functions
            "date",
            "date_in_zone",
            "date_modify",
            "now",
            "htmlDate",
            "htmlDateInZone",
            "dateInZone",
            "dateModify",

            // Strings
            "randAlphaNum",
            "randAlpha",
            "randAscii",
            "randNumeric",
            "uuidv4",

            // OS
            "env",
            "expandenv",

            // Network
            "getHostByName",

Signed-off-by: Soule BA <bah.soule@gmail.com>
2021-10-12 11:41:03 +02:00
Aaron Trout c99bc07ac7
Fix Typo: policiy -> policy
Signed-off-by: Aaron Trout <atrout@confluent.io>
2021-07-14 12:54:13 +01:00
Michael Bridgen f64d6cd4c8 Port API guide from v1alpha2 to v1beta1
The guides are kept in versioned directories, but only one version
appears to make it to the documentation website. For that reason,
rather than trying to refer to the previous version's migration guide,
I've just copied it and adapted it minimally to the new version.

Signed-off-by: Michael Bridgen <michael@weave.works>
2021-06-28 11:26:59 +01:00
Michael Bridgen 7378ad7ae7 Change note regarding git implementation field
The implementation is now ignored, in favour of just using libgit2.

Signed-off-by: Michael Bridgen <michael@weave.works>
2021-06-02 15:00:36 +01:00
Hidde Beydals 4a71491565 spec: formatting `v1alpha1` -> `v1alpha2` table
The previous format seems to have been a mixture of the format accepted
by most Markdown parsers, and the format Org Mode for Emacs likes.

Anyhow, we breathe Markdown.

Signed-off-by: Hidde Beydals <hello@hidde.co>
2021-04-22 12:15:37 +02:00
Michael Bridgen f746a110c2 Add guide to migrating to v1alpha2
This commit adds a step-by-step guide to rewriting specs for v1alpha2.

Signed-off-by: Michael Bridgen <michael@weave.works>
2021-04-13 11:01:45 +01:00
Michael Bridgen b0fc4155fe Write a specification explainer for v1alpha2
This mostly adapts the material in the v1alpha1 spec explainer doc to
the different structure of the v1alpha2 types.

Signed-off-by: Michael Bridgen <michael@weave.works>
2021-04-13 11:01:45 +01:00
Stefan Prodan 1332f65372
Release v0.8.0
Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>
2021-04-06 17:27:40 +03:00
Jason Raimondi 22fd7a0c77
Fix typo in template code example
Signed-off-by: Jason Raimondi <jason@raimondi.us>
2021-03-18 14:28:56 -07:00
Stefan Prodan 2e53745a03
Allow specifying the path for manifests updates
- Add optional `path` field to `spec.update`, defaults to the git repo root
- Restrict updates to the specified `spec.update.path`

Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>
2021-03-16 11:58:21 +02:00
Michael Bridgen 340d1a4462 Give an example of {checkout,push}.branch
As a YAML example, this also shows the YAML/JSON field names. Since
field names are different in the Go types, it can be confusing.

Signed-off-by: Michael Bridgen <michael@weave.works>
2021-03-15 15:24:09 +00:00
Michael Bridgen 076758aec7 Explain how the push field works
Signed-off-by: Michael Bridgen <michael@weave.works>
2021-03-15 15:08:06 +00:00
Michael Bridgen cfa5a9c574 Phrase the message template example as YAML not go
The message template is used in YAML files, not in go code. I've also
explained up-front that it's a text template -- something not
mentioned to this point.

Signed-off-by: Michael Bridgen <michael@weave.works>
2021-03-04 13:28:37 +00:00
Michael Bridgen df7d570ae5 Give details of template data in spec docs
This explains the data available to the commit message template in the
API guide. While writing it, I realised it could be made more
convenient, so:

 - mask external types by embedding them
 - make the most useful parts of an image ref available using a
   wrapper struct and interface

Signed-off-by: Michael Bridgen <michael@weave.works>
2021-03-03 11:08:53 +00:00
Michael Bridgen 78dec3ce89 Update API refs
This commit updates the generated and written API refs to account for
the new update strategy types.

Signed-off-by: Michael Bridgen <michael@weave.works>
2021-01-20 13:59:15 +00:00
Michael Bridgen c33541dd08 Add API reference for ImageUpdateAutomation
Signed-off-by: Michael Bridgen <michael@weave.works>
2021-01-18 14:40:08 +00:00