fluxcd
/
source-controller
mirror of https://github.com/fluxcd/source-controller.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #100 from fluxcd/spec/domain-change 

Change CRD domain to 'source.toolkit.fluxcd.io'
This commit is contained in:
Hidde Beydals 2020-07-31 08:05:25 +02:00 committed by GitHub
parent 657a76dbe5 8e1b213da5
commit dc4d4ed1e9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
27 changed files with 110 additions and 111 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CHANGELOG.md
View File

@ -94,6 +94,6 @@ and `HelmRepositoryReconciler`.
This is the first alpha release of source controller. This is the first alpha release of source controller.
The controller is an implementation of the The controller is an implementation of the
[source.fluxcd.io/v1alpha1](https://github.com/fluxcd/source-controller/tree/master/docs/spec/v1alpha1) API [source.fluxcd.io/v1alpha1](https://github.com/fluxcd/source-controller/tree/v0.0.1-alpha.1/docs/spec/v1alpha1) API
based on the specifications described in the based on the specifications described in the
[Source Controller Proposal](https://github.com/fluxcd/source-controller/tree/master/docs/spec). [Source Controller Proposal](https://github.com/fluxcd/source-controller/tree/v0.0.1-alpha.1/docs/spec).

2
PROJECT
View File

@ -1,4 +1,4 @@
domain: fluxcd.io domain: toolkit.fluxcd.io
repo: github.com/fluxcd/source-controller repo: github.com/fluxcd/source-controller
resources: resources:
- group: source - group: source

2
README.md
View File

@ -8,7 +8,7 @@
The source-controller is a Kubernetes operator, specialised in artifacts acquisition The source-controller is a Kubernetes operator, specialised in artifacts acquisition
from external sources such as Git and Helm repositories. from external sources such as Git and Helm repositories.
The source-controller implements the The source-controller implements the
[source.fluxcd.io](https://github.com/fluxcd/source-controller/tree/master/docs/spec/v1alpha1) API [source.toolkit.fluxcd.io](https://github.com/fluxcd/source-controller/tree/master/docs/spec/v1alpha1) API
and is a core component of the [GitOps toolkit](https://toolkit.fluxcd.io). and is a core component of the [GitOps toolkit](https://toolkit.fluxcd.io).
![overview](docs/diagrams/source-controller-overview.png) ![overview](docs/diagrams/source-controller-overview.png)

2
api/v1alpha1/doc.go
View File

@ -16,5 +16,5 @@ limitations under the License.
// Package v1alpha1 contains API Schema definitions for the source v1alpha1 API group // Package v1alpha1 contains API Schema definitions for the source v1alpha1 API group
// +kubebuilder:object:generate=true // +kubebuilder:object:generate=true
// +groupName=source.fluxcd.io // +groupName=source.toolkit.fluxcd.io
package v1alpha1 package v1alpha1

2
api/v1alpha1/groupversion_info.go
View File

@ -23,7 +23,7 @@ import (
var ( var (
// GroupVersion is group version used to register these objects. // GroupVersion is group version used to register these objects.
GroupVersion = schema.GroupVersion{Group: "source.fluxcd.io", Version: "v1alpha1"} GroupVersion = schema.GroupVersion{Group: "source.toolkit.fluxcd.io", Version: "v1alpha1"}
// SchemeBuilder is used to add go types to the GroupVersionKind scheme. // SchemeBuilder is used to add go types to the GroupVersionKind scheme.
SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion} SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}

4
config/crd/bases/source.fluxcd.io_gitrepositories.yaml → config/crd/bases/source.toolkit.fluxcd.io_gitrepositories.yaml
View File

@ -6,9 +6,9 @@ metadata:
annotations: annotations:
controller-gen.kubebuilder.io/version: v0.3.0 controller-gen.kubebuilder.io/version: v0.3.0
creationTimestamp: null creationTimestamp: null
name: gitrepositories.source.fluxcd.io name: gitrepositories.source.toolkit.fluxcd.io
spec: spec:
group: source.fluxcd.io group: source.toolkit.fluxcd.io
names: names:
kind: GitRepository kind: GitRepository
listKind: GitRepositoryList listKind: GitRepositoryList

4
config/crd/bases/source.fluxcd.io_helmcharts.yaml → config/crd/bases/source.toolkit.fluxcd.io_helmcharts.yaml
View File

@ -6,9 +6,9 @@ metadata:
annotations: annotations:
controller-gen.kubebuilder.io/version: v0.3.0 controller-gen.kubebuilder.io/version: v0.3.0
creationTimestamp: null creationTimestamp: null
name: helmcharts.source.fluxcd.io name: helmcharts.source.toolkit.fluxcd.io
spec: spec:
group: source.fluxcd.io group: source.toolkit.fluxcd.io
names: names:
kind: HelmChart kind: HelmChart
listKind: HelmChartList listKind: HelmChartList

4
config/crd/bases/source.fluxcd.io_helmrepositories.yaml → config/crd/bases/source.toolkit.fluxcd.io_helmrepositories.yaml
View File

@ -6,9 +6,9 @@ metadata:
annotations: annotations:
controller-gen.kubebuilder.io/version: v0.3.0 controller-gen.kubebuilder.io/version: v0.3.0
creationTimestamp: null creationTimestamp: null
name: helmrepositories.source.fluxcd.io name: helmrepositories.source.toolkit.fluxcd.io
spec: spec:
group: source.fluxcd.io group: source.toolkit.fluxcd.io
names: names:
kind: HelmRepository kind: HelmRepository
listKind: HelmRepositoryList listKind: HelmRepositoryList

7
config/crd/kustomization.yaml
View File

@ -1,8 +1,7 @@
apiVersion: kustomize.config.k8s.io/v1beta1 apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization kind: Kustomization
resources: resources:
- bases/source.fluxcd.io_gitrepositories.yaml - bases/source.toolkit.fluxcd.io_gitrepositories.yaml
- bases/source.fluxcd.io_helmrepositories.yaml - bases/source.toolkit.fluxcd.io_helmrepositories.yaml
- bases/source.fluxcd.io_helmcharts.yaml - bases/source.toolkit.fluxcd.io_helmcharts.yaml
# +kubebuilder:scaffold:crdkustomizeresource # +kubebuilder:scaffold:crdkustomizeresource

4
config/rbac/gitrepository_editor_role.yaml
View File

@ -5,7 +5,7 @@ metadata:
name: gitrepository-editor-role name: gitrepository-editor-role
rules: rules:
- apiGroups: - apiGroups:
- source.fluxcd.io - source.toolkit.fluxcd.io
resources: resources:
- gitrepositories - gitrepositories
verbs: verbs:
@ -17,7 +17,7 @@ rules:
- update - update
- watch - watch
- apiGroups: - apiGroups:
- source.fluxcd.io - source.toolkit.fluxcd.io
resources: resources:
- gitrepositories/status - gitrepositories/status
verbs: verbs:

4
config/rbac/gitrepository_viewer_role.yaml
View File

@ -5,7 +5,7 @@ metadata:
name: gitrepository-viewer-role name: gitrepository-viewer-role
rules: rules:
- apiGroups: - apiGroups:
- source.fluxcd.io - source.toolkit.fluxcd.io
resources: resources:
- gitrepositories - gitrepositories
verbs: verbs:
@ -13,7 +13,7 @@ rules:
- list - list
- watch - watch
- apiGroups: - apiGroups:
- source.fluxcd.io - source.toolkit.fluxcd.io
resources: resources:
- gitrepositories/status - gitrepositories/status
verbs: verbs:

4
config/rbac/helmchart_editor_role.yaml
View File

@ -5,7 +5,7 @@ metadata:
name: helmchart-editor-role name: helmchart-editor-role
rules: rules:
- apiGroups: - apiGroups:
- source.fluxcd.io - source.toolkit.fluxcd.io
resources: resources:
- helmcharts - helmcharts
verbs: verbs:
@ -17,7 +17,7 @@ rules:
- update - update
- watch - watch
- apiGroups: - apiGroups:
- source.fluxcd.io - source.toolkit.fluxcd.io
resources: resources:
- helmcharts/status - helmcharts/status
verbs: verbs:

4
config/rbac/helmchart_viewer_role.yaml
View File

@ -5,7 +5,7 @@ metadata:
name: helmchart-viewer-role name: helmchart-viewer-role
rules: rules:
- apiGroups: - apiGroups:
- source.fluxcd.io - source.toolkit.fluxcd.io
resources: resources:
- helmcharts - helmcharts
verbs: verbs:
@ -13,7 +13,7 @@ rules:
- list - list
- watch - watch
- apiGroups: - apiGroups:
- source.fluxcd.io - source.toolkit.fluxcd.io
resources: resources:
- helmcharts/status - helmcharts/status
verbs: verbs:

4
config/rbac/helmrepository_editor_role.yaml
View File

@ -5,7 +5,7 @@ metadata:
name: helmrepository-editor-role name: helmrepository-editor-role
rules: rules:
- apiGroups: - apiGroups:
- source.fluxcd.io - source.toolkit.fluxcd.io
resources: resources:
- helmrepositories - helmrepositories
verbs: verbs:
@ -17,7 +17,7 @@ rules:
- update - update
- watch - watch
- apiGroups: - apiGroups:
- source.fluxcd.io - source.toolkit.fluxcd.io
resources: resources:
- helmrepositories/status - helmrepositories/status
verbs: verbs:

4
config/rbac/helmrepository_viewer_role.yaml
View File

@ -5,7 +5,7 @@ metadata:
name: helmrepository-viewer-role name: helmrepository-viewer-role
rules: rules:
- apiGroups: - apiGroups:
- source.fluxcd.io - source.toolkit.fluxcd.io
resources: resources:
- helmrepositories - helmrepositories
verbs: verbs:
@ -13,7 +13,7 @@ rules:
- list - list
- watch - watch
- apiGroups: - apiGroups:
- source.fluxcd.io - source.toolkit.fluxcd.io
resources: resources:
- helmrepositories/status - helmrepositories/status
verbs: verbs:

14
config/rbac/role.yaml
View File

@ -7,7 +7,7 @@ metadata:
name: manager-role name: manager-role
rules: rules:
- apiGroups: - apiGroups:
- source.fluxcd.io - source.toolkit.fluxcd.io
resources: resources:
- gitrepositories - gitrepositories
verbs: verbs:
@ -19,7 +19,7 @@ rules:
- update - update
- watch - watch
- apiGroups: - apiGroups:
- source.fluxcd.io - source.toolkit.fluxcd.io
resources: resources:
- gitrepositories/status - gitrepositories/status
verbs: verbs:
@ -27,7 +27,7 @@ rules:
- patch - patch
- update - update
- apiGroups: - apiGroups:
- source.fluxcd.io - source.toolkit.fluxcd.io
resources: resources:
- helmcharts - helmcharts
verbs: verbs:
@ -39,7 +39,7 @@ rules:
- update - update
- watch - watch
- apiGroups: - apiGroups:
- source.fluxcd.io - source.toolkit.fluxcd.io
resources: resources:
- helmcharts/finalizers - helmcharts/finalizers
verbs: verbs:
@ -47,7 +47,7 @@ rules:
- patch - patch
- update - update
- apiGroups: - apiGroups:
- source.fluxcd.io - source.toolkit.fluxcd.io
resources: resources:
- helmcharts/status - helmcharts/status
verbs: verbs:
@ -55,7 +55,7 @@ rules:
- patch - patch
- update - update
- apiGroups: - apiGroups:
- source.fluxcd.io - source.toolkit.fluxcd.io
resources: resources:
- helmrepositories - helmrepositories
verbs: verbs:
@ -67,7 +67,7 @@ rules:
- update - update
- watch - watch
- apiGroups: - apiGroups:
- source.fluxcd.io - source.toolkit.fluxcd.io
resources: resources:
- helmrepositories/status - helmrepositories/status
verbs: verbs:

2
config/samples/source_v1alpha1_gitrepository.yaml
View File

@ -1,4 +1,4 @@
apiVersion: source.fluxcd.io/v1alpha1 apiVersion: source.toolkit.fluxcd.io/v1alpha1
kind: GitRepository kind: GitRepository
metadata: metadata:
name: gitrepository-sample name: gitrepository-sample

2
config/samples/source_v1alpha1_helmchart.yaml
View File

@ -1,4 +1,4 @@
apiVersion: source.fluxcd.io/v1alpha1 apiVersion: source.toolkit.fluxcd.io/v1alpha1
kind: HelmChart kind: HelmChart
metadata: metadata:
name: helmchart-sample name: helmchart-sample

2
config/samples/source_v1alpha1_helmrepository.yaml
View File

@ -1,4 +1,4 @@
apiVersion: source.fluxcd.io/v1alpha1 apiVersion: source.toolkit.fluxcd.io/v1alpha1
kind: HelmRepository kind: HelmRepository
metadata: metadata:
name: helmrepository-sample name: helmrepository-sample

4
controllers/gitrepository_controller.go
View File

@ -53,8 +53,8 @@ type GitRepositoryReconciler struct {
ExternalEventRecorder *recorder.EventRecorder ExternalEventRecorder *recorder.EventRecorder
} }
// +kubebuilder:rbac:groups=source.fluxcd.io,resources=gitrepositories,verbs=get;list;watch;create;update;patch;delete // +kubebuilder:rbac:groups=source.toolkit.fluxcd.io,resources=gitrepositories,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups=source.fluxcd.io,resources=gitrepositories/status,verbs=get;update;patch // +kubebuilder:rbac:groups=source.toolkit.fluxcd.io,resources=gitrepositories/status,verbs=get;update;patch
func (r *GitRepositoryReconciler) Reconcile(req ctrl.Request) (ctrl.Result, error) { func (r *GitRepositoryReconciler) Reconcile(req ctrl.Request) (ctrl.Result, error) {
ctx := context.Background() ctx := context.Background()

4
controllers/helmchart_controller.go
View File

@ -54,8 +54,8 @@ type HelmChartReconciler struct {
ExternalEventRecorder *recorder.EventRecorder ExternalEventRecorder *recorder.EventRecorder
} }
// +kubebuilder:rbac:groups=source.fluxcd.io,resources=helmcharts,verbs=get;list;watch;create;update;patch;delete // +kubebuilder:rbac:groups=source.toolkit.fluxcd.io,resources=helmcharts,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups=source.fluxcd.io,resources=helmcharts/status,verbs=get;update;patch // +kubebuilder:rbac:groups=source.toolkit.fluxcd.io,resources=helmcharts/status,verbs=get;update;patch
func (r *HelmChartReconciler) Reconcile(req ctrl.Request) (ctrl.Result, error) { func (r *HelmChartReconciler) Reconcile(req ctrl.Request) (ctrl.Result, error) {
ctx := context.Background() ctx := context.Background()

6
controllers/helmrepository_controller.go
View File

@ -55,9 +55,9 @@ type HelmRepositoryReconciler struct {
ExternalEventRecorder *recorder.EventRecorder ExternalEventRecorder *recorder.EventRecorder
} }
// +kubebuilder:rbac:groups=source.fluxcd.io,resources=helmrepositories,verbs=get;list;watch;create;update;patch;delete // +kubebuilder:rbac:groups=source.toolkit.fluxcd.io,resources=helmrepositories,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups=source.fluxcd.io,resources=helmrepositories/status,verbs=get;update;patch // +kubebuilder:rbac:groups=source.toolkit.fluxcd.io,resources=helmrepositories/status,verbs=get;update;patch
// +kubebuilder:rbac:groups=source.fluxcd.io,resources=helmcharts/finalizers,verbs=get;update;patch // +kubebuilder:rbac:groups=source.toolkit.fluxcd.io,resources=helmcharts/finalizers,verbs=get;update;patch
func (r *HelmRepositoryReconciler) Reconcile(req ctrl.Request) (ctrl.Result, error) { func (r *HelmRepositoryReconciler) Reconcile(req ctrl.Request) (ctrl.Result, error) {
ctx := context.Background() ctx := context.Background()

104
docs/api/source.md
View File

@ -2,20 +2,20 @@
<p>Packages:</p> <p>Packages:</p>
<ul class="simple"> <ul class="simple">
<li> <li>
<a href="#source.fluxcd.io%2fv1alpha1">source.fluxcd.io/v1alpha1</a> <a href="#source.toolkit.fluxcd.io%2fv1alpha1">source.toolkit.fluxcd.io/v1alpha1</a>
</li> </li>
</ul> </ul>
<h2 id="source.fluxcd.io/v1alpha1">source.fluxcd.io/v1alpha1</h2> <h2 id="source.toolkit.fluxcd.io/v1alpha1">source.toolkit.fluxcd.io/v1alpha1</h2>
<p>Package v1alpha1 contains API Schema definitions for the source v1alpha1 API group</p> <p>Package v1alpha1 contains API Schema definitions for the source v1alpha1 API group</p>
Resource Types: Resource Types:
<ul class="simple"><li> <ul class="simple"><li>
<a href="#source.fluxcd.io/v1alpha1.GitRepository">GitRepository</a> <a href="#source.toolkit.fluxcd.io/v1alpha1.GitRepository">GitRepository</a>
</li><li> </li><li>
<a href="#source.fluxcd.io/v1alpha1.HelmChart">HelmChart</a> <a href="#source.toolkit.fluxcd.io/v1alpha1.HelmChart">HelmChart</a>
</li><li> </li><li>
<a href="#source.fluxcd.io/v1alpha1.HelmRepository">HelmRepository</a> <a href="#source.toolkit.fluxcd.io/v1alpha1.HelmRepository">HelmRepository</a>
</li></ul> </li></ul>
<h3 id="source.fluxcd.io/v1alpha1.GitRepository">GitRepository <h3 id="source.toolkit.fluxcd.io/v1alpha1.GitRepository">GitRepository
</h3> </h3>
<p>GitRepository is the Schema for the gitrepositories API</p> <p>GitRepository is the Schema for the gitrepositories API</p>
<div class="md-typeset__scrollwrap"> <div class="md-typeset__scrollwrap">
@ -33,7 +33,7 @@ Resource Types:
<code>apiVersion</code><br> <code>apiVersion</code><br>
string</td> string</td>
<td> <td>
<code>source.fluxcd.io/v1alpha1</code> <code>source.toolkit.fluxcd.io/v1alpha1</code>
</td> </td>
</tr> </tr>
<tr> <tr>
@ -63,7 +63,7 @@ Refer to the Kubernetes API documentation for the fields of the
<td> <td>
<code>spec</code><br> <code>spec</code><br>
<em> <em>
<a href="#source.fluxcd.io/v1alpha1.GitRepositorySpec"> <a href="#source.toolkit.fluxcd.io/v1alpha1.GitRepositorySpec">
GitRepositorySpec GitRepositorySpec
</a> </a>
</em> </em>
@ -132,7 +132,7 @@ Kubernetes meta/v1.Duration
<td> <td>
<code>ref</code><br> <code>ref</code><br>
<em> <em>
<a href="#source.fluxcd.io/v1alpha1.GitRepositoryRef"> <a href="#source.toolkit.fluxcd.io/v1alpha1.GitRepositoryRef">
GitRepositoryRef GitRepositoryRef
</a> </a>
</em> </em>
@ -147,7 +147,7 @@ master branch.</p>
<td> <td>
<code>verify</code><br> <code>verify</code><br>
<em> <em>
<a href="#source.fluxcd.io/v1alpha1.GitRepositoryVerification"> <a href="#source.toolkit.fluxcd.io/v1alpha1.GitRepositoryVerification">
GitRepositoryVerification GitRepositoryVerification
</a> </a>
</em> </em>
@ -179,7 +179,7 @@ are.</p>
<td> <td>
<code>status</code><br> <code>status</code><br>
<em> <em>
<a href="#source.fluxcd.io/v1alpha1.GitRepositoryStatus"> <a href="#source.toolkit.fluxcd.io/v1alpha1.GitRepositoryStatus">
GitRepositoryStatus GitRepositoryStatus
</a> </a>
</em> </em>
@ -191,7 +191,7 @@ GitRepositoryStatus
</table> </table>
</div> </div>
</div> </div>
<h3 id="source.fluxcd.io/v1alpha1.HelmChart">HelmChart <h3 id="source.toolkit.fluxcd.io/v1alpha1.HelmChart">HelmChart
</h3> </h3>
<p>HelmChart is the Schema for the helmcharts API</p> <p>HelmChart is the Schema for the helmcharts API</p>
<div class="md-typeset__scrollwrap"> <div class="md-typeset__scrollwrap">
@ -209,7 +209,7 @@ GitRepositoryStatus
<code>apiVersion</code><br> <code>apiVersion</code><br>
string</td> string</td>
<td> <td>
<code>source.fluxcd.io/v1alpha1</code> <code>source.toolkit.fluxcd.io/v1alpha1</code>
</td> </td>
</tr> </tr>
<tr> <tr>
@ -239,7 +239,7 @@ Refer to the Kubernetes API documentation for the fields of the
<td> <td>
<code>spec</code><br> <code>spec</code><br>
<em> <em>
<a href="#source.fluxcd.io/v1alpha1.HelmChartSpec"> <a href="#source.toolkit.fluxcd.io/v1alpha1.HelmChartSpec">
HelmChartSpec HelmChartSpec
</a> </a>
</em> </em>
@ -306,7 +306,7 @@ Kubernetes meta/v1.Duration
<td> <td>
<code>status</code><br> <code>status</code><br>
<em> <em>
<a href="#source.fluxcd.io/v1alpha1.HelmChartStatus"> <a href="#source.toolkit.fluxcd.io/v1alpha1.HelmChartStatus">
HelmChartStatus HelmChartStatus
</a> </a>
</em> </em>
@ -318,7 +318,7 @@ HelmChartStatus
</table> </table>
</div> </div>
</div> </div>
<h3 id="source.fluxcd.io/v1alpha1.HelmRepository">HelmRepository <h3 id="source.toolkit.fluxcd.io/v1alpha1.HelmRepository">HelmRepository
</h3> </h3>
<p>HelmRepository is the Schema for the helmrepositories API</p> <p>HelmRepository is the Schema for the helmrepositories API</p>
<div class="md-typeset__scrollwrap"> <div class="md-typeset__scrollwrap">
@ -336,7 +336,7 @@ HelmChartStatus
<code>apiVersion</code><br> <code>apiVersion</code><br>
string</td> string</td>
<td> <td>
<code>source.fluxcd.io/v1alpha1</code> <code>source.toolkit.fluxcd.io/v1alpha1</code>
</td> </td>
</tr> </tr>
<tr> <tr>
@ -366,7 +366,7 @@ Refer to the Kubernetes API documentation for the fields of the
<td> <td>
<code>spec</code><br> <code>spec</code><br>
<em> <em>
<a href="#source.fluxcd.io/v1alpha1.HelmRepositorySpec"> <a href="#source.toolkit.fluxcd.io/v1alpha1.HelmRepositorySpec">
HelmRepositorySpec HelmRepositorySpec
</a> </a>
</em> </em>
@ -425,7 +425,7 @@ Kubernetes meta/v1.Duration
<td> <td>
<code>status</code><br> <code>status</code><br>
<em> <em>
<a href="#source.fluxcd.io/v1alpha1.HelmRepositoryStatus"> <a href="#source.toolkit.fluxcd.io/v1alpha1.HelmRepositoryStatus">
HelmRepositoryStatus HelmRepositoryStatus
</a> </a>
</em> </em>
@ -437,13 +437,13 @@ HelmRepositoryStatus
</table> </table>
</div> </div>
</div> </div>
<h3 id="source.fluxcd.io/v1alpha1.Artifact">Artifact <h3 id="source.toolkit.fluxcd.io/v1alpha1.Artifact">Artifact
</h3> </h3>
<p> <p>
(<em>Appears on:</em> (<em>Appears on:</em>
<a href="#source.fluxcd.io/v1alpha1.GitRepositoryStatus">GitRepositoryStatus</a>, <a href="#source.toolkit.fluxcd.io/v1alpha1.GitRepositoryStatus">GitRepositoryStatus</a>,
<a href="#source.fluxcd.io/v1alpha1.HelmChartStatus">HelmChartStatus</a>, <a href="#source.toolkit.fluxcd.io/v1alpha1.HelmChartStatus">HelmChartStatus</a>,
<a href="#source.fluxcd.io/v1alpha1.HelmRepositoryStatus">HelmRepositoryStatus</a>) <a href="#source.toolkit.fluxcd.io/v1alpha1.HelmRepositoryStatus">HelmRepositoryStatus</a>)
</p> </p>
<p>Artifact represents the output of a source synchronisation</p> <p>Artifact represents the output of a source synchronisation</p>
<div class="md-typeset__scrollwrap"> <div class="md-typeset__scrollwrap">
@ -510,11 +510,11 @@ update of this artifact.</p>
</table> </table>
</div> </div>
</div> </div>
<h3 id="source.fluxcd.io/v1alpha1.GitRepositoryRef">GitRepositoryRef <h3 id="source.toolkit.fluxcd.io/v1alpha1.GitRepositoryRef">GitRepositoryRef
</h3> </h3>
<p> <p>
(<em>Appears on:</em> (<em>Appears on:</em>
<a href="#source.fluxcd.io/v1alpha1.GitRepositorySpec">GitRepositorySpec</a>) <a href="#source.toolkit.fluxcd.io/v1alpha1.GitRepositorySpec">GitRepositorySpec</a>)
</p> </p>
<p>GitRepositoryRef defines the git ref used for pull and checkout operations.</p> <p>GitRepositoryRef defines the git ref used for pull and checkout operations.</p>
<div class="md-typeset__scrollwrap"> <div class="md-typeset__scrollwrap">
@ -579,11 +579,11 @@ string
</table> </table>
</div> </div>
</div> </div>
<h3 id="source.fluxcd.io/v1alpha1.GitRepositorySpec">GitRepositorySpec <h3 id="source.toolkit.fluxcd.io/v1alpha1.GitRepositorySpec">GitRepositorySpec
</h3> </h3>
<p> <p>
(<em>Appears on:</em> (<em>Appears on:</em>
<a href="#source.fluxcd.io/v1alpha1.GitRepository">GitRepository</a>) <a href="#source.toolkit.fluxcd.io/v1alpha1.GitRepository">GitRepository</a>)
</p> </p>
<p>GitRepositorySpec defines the desired state of a Git repository.</p> <p>GitRepositorySpec defines the desired state of a Git repository.</p>
<div class="md-typeset__scrollwrap"> <div class="md-typeset__scrollwrap">
@ -656,7 +656,7 @@ Kubernetes meta/v1.Duration
<td> <td>
<code>ref</code><br> <code>ref</code><br>
<em> <em>
<a href="#source.fluxcd.io/v1alpha1.GitRepositoryRef"> <a href="#source.toolkit.fluxcd.io/v1alpha1.GitRepositoryRef">
GitRepositoryRef GitRepositoryRef
</a> </a>
</em> </em>
@ -671,7 +671,7 @@ master branch.</p>
<td> <td>
<code>verify</code><br> <code>verify</code><br>
<em> <em>
<a href="#source.fluxcd.io/v1alpha1.GitRepositoryVerification"> <a href="#source.toolkit.fluxcd.io/v1alpha1.GitRepositoryVerification">
GitRepositoryVerification GitRepositoryVerification
</a> </a>
</em> </em>
@ -700,11 +700,11 @@ are.</p>
</table> </table>
</div> </div>
</div> </div>
<h3 id="source.fluxcd.io/v1alpha1.GitRepositoryStatus">GitRepositoryStatus <h3 id="source.toolkit.fluxcd.io/v1alpha1.GitRepositoryStatus">GitRepositoryStatus
</h3> </h3>
<p> <p>
(<em>Appears on:</em> (<em>Appears on:</em>
<a href="#source.fluxcd.io/v1alpha1.GitRepository">GitRepository</a>) <a href="#source.toolkit.fluxcd.io/v1alpha1.GitRepository">GitRepository</a>)
</p> </p>
<p>GitRepositoryStatus defines the observed state of a Git repository.</p> <p>GitRepositoryStatus defines the observed state of a Git repository.</p>
<div class="md-typeset__scrollwrap"> <div class="md-typeset__scrollwrap">
@ -721,7 +721,7 @@ are.</p>
<td> <td>
<code>conditions</code><br> <code>conditions</code><br>
<em> <em>
<a href="#source.fluxcd.io/v1alpha1.SourceCondition"> <a href="#source.toolkit.fluxcd.io/v1alpha1.SourceCondition">
[]SourceCondition []SourceCondition
</a> </a>
</em> </em>
@ -747,7 +747,7 @@ sync.</p>
<td> <td>
<code>artifact</code><br> <code>artifact</code><br>
<em> <em>
<a href="#source.fluxcd.io/v1alpha1.Artifact"> <a href="#source.toolkit.fluxcd.io/v1alpha1.Artifact">
Artifact Artifact
</a> </a>
</em> </em>
@ -761,11 +761,11 @@ Artifact
</table> </table>
</div> </div>
</div> </div>
<h3 id="source.fluxcd.io/v1alpha1.GitRepositoryVerification">GitRepositoryVerification <h3 id="source.toolkit.fluxcd.io/v1alpha1.GitRepositoryVerification">GitRepositoryVerification
</h3> </h3>
<p> <p>
(<em>Appears on:</em> (<em>Appears on:</em>
<a href="#source.fluxcd.io/v1alpha1.GitRepositorySpec">GitRepositorySpec</a>) <a href="#source.toolkit.fluxcd.io/v1alpha1.GitRepositorySpec">GitRepositorySpec</a>)
</p> </p>
<p>GitRepositoryVerification defines the OpenPGP signature verification process.</p> <p>GitRepositoryVerification defines the OpenPGP signature verification process.</p>
<div class="md-typeset__scrollwrap"> <div class="md-typeset__scrollwrap">
@ -806,11 +806,11 @@ Kubernetes core/v1.LocalObjectReference
</table> </table>
</div> </div>
</div> </div>
<h3 id="source.fluxcd.io/v1alpha1.HelmChartSpec">HelmChartSpec <h3 id="source.toolkit.fluxcd.io/v1alpha1.HelmChartSpec">HelmChartSpec
</h3> </h3>
<p> <p>
(<em>Appears on:</em> (<em>Appears on:</em>
<a href="#source.fluxcd.io/v1alpha1.HelmChart">HelmChart</a>) <a href="#source.toolkit.fluxcd.io/v1alpha1.HelmChart">HelmChart</a>)
</p> </p>
<p>HelmChartSpec defines the desired state of a Helm chart.</p> <p>HelmChartSpec defines the desired state of a Helm chart.</p>
<div class="md-typeset__scrollwrap"> <div class="md-typeset__scrollwrap">
@ -878,11 +878,11 @@ Kubernetes meta/v1.Duration
</table> </table>
</div> </div>
</div> </div>
<h3 id="source.fluxcd.io/v1alpha1.HelmChartStatus">HelmChartStatus <h3 id="source.toolkit.fluxcd.io/v1alpha1.HelmChartStatus">HelmChartStatus
</h3> </h3>
<p> <p>
(<em>Appears on:</em> (<em>Appears on:</em>
<a href="#source.fluxcd.io/v1alpha1.HelmChart">HelmChart</a>) <a href="#source.toolkit.fluxcd.io/v1alpha1.HelmChart">HelmChart</a>)
</p> </p>
<p>HelmChartStatus defines the observed state of the HelmChart.</p> <p>HelmChartStatus defines the observed state of the HelmChart.</p>
<div class="md-typeset__scrollwrap"> <div class="md-typeset__scrollwrap">
@ -899,7 +899,7 @@ Kubernetes meta/v1.Duration
<td> <td>
<code>conditions</code><br> <code>conditions</code><br>
<em> <em>
<a href="#source.fluxcd.io/v1alpha1.SourceCondition"> <a href="#source.toolkit.fluxcd.io/v1alpha1.SourceCondition">
[]SourceCondition []SourceCondition
</a> </a>
</em> </em>
@ -924,7 +924,7 @@ string
<td> <td>
<code>artifact</code><br> <code>artifact</code><br>
<em> <em>
<a href="#source.fluxcd.io/v1alpha1.Artifact"> <a href="#source.toolkit.fluxcd.io/v1alpha1.Artifact">
Artifact Artifact
</a> </a>
</em> </em>
@ -938,11 +938,11 @@ Artifact
</table> </table>
</div> </div>
</div> </div>
<h3 id="source.fluxcd.io/v1alpha1.HelmRepositorySpec">HelmRepositorySpec <h3 id="source.toolkit.fluxcd.io/v1alpha1.HelmRepositorySpec">HelmRepositorySpec
</h3> </h3>
<p> <p>
(<em>Appears on:</em> (<em>Appears on:</em>
<a href="#source.fluxcd.io/v1alpha1.HelmRepository">HelmRepository</a>) <a href="#source.toolkit.fluxcd.io/v1alpha1.HelmRepository">HelmRepository</a>)
</p> </p>
<p>HelmRepositorySpec defines the reference to a Helm repository.</p> <p>HelmRepositorySpec defines the reference to a Helm repository.</p>
<div class="md-typeset__scrollwrap"> <div class="md-typeset__scrollwrap">
@ -1002,11 +1002,11 @@ Kubernetes meta/v1.Duration
</table> </table>
</div> </div>
</div> </div>
<h3 id="source.fluxcd.io/v1alpha1.HelmRepositoryStatus">HelmRepositoryStatus <h3 id="source.toolkit.fluxcd.io/v1alpha1.HelmRepositoryStatus">HelmRepositoryStatus
</h3> </h3>
<p> <p>
(<em>Appears on:</em> (<em>Appears on:</em>
<a href="#source.fluxcd.io/v1alpha1.HelmRepository">HelmRepository</a>) <a href="#source.toolkit.fluxcd.io/v1alpha1.HelmRepository">HelmRepository</a>)
</p> </p>
<p>HelmRepositoryStatus defines the observed state of the HelmRepository.</p> <p>HelmRepositoryStatus defines the observed state of the HelmRepository.</p>
<div class="md-typeset__scrollwrap"> <div class="md-typeset__scrollwrap">
@ -1023,7 +1023,7 @@ Kubernetes meta/v1.Duration
<td> <td>
<code>conditions</code><br> <code>conditions</code><br>
<em> <em>
<a href="#source.fluxcd.io/v1alpha1.SourceCondition"> <a href="#source.toolkit.fluxcd.io/v1alpha1.SourceCondition">
[]SourceCondition []SourceCondition
</a> </a>
</em> </em>
@ -1048,7 +1048,7 @@ string
<td> <td>
<code>artifact</code><br> <code>artifact</code><br>
<em> <em>
<a href="#source.fluxcd.io/v1alpha1.Artifact"> <a href="#source.toolkit.fluxcd.io/v1alpha1.Artifact">
Artifact Artifact
</a> </a>
</em> </em>
@ -1062,16 +1062,16 @@ Artifact
</table> </table>
</div> </div>
</div> </div>
<h3 id="source.fluxcd.io/v1alpha1.Source">Source <h3 id="source.toolkit.fluxcd.io/v1alpha1.Source">Source
</h3> </h3>
<p>Source interface must be supported by all API types.</p> <p>Source interface must be supported by all API types.</p>
<h3 id="source.fluxcd.io/v1alpha1.SourceCondition">SourceCondition <h3 id="source.toolkit.fluxcd.io/v1alpha1.SourceCondition">SourceCondition
</h3> </h3>
<p> <p>
(<em>Appears on:</em> (<em>Appears on:</em>
<a href="#source.fluxcd.io/v1alpha1.GitRepositoryStatus">GitRepositoryStatus</a>, <a href="#source.toolkit.fluxcd.io/v1alpha1.GitRepositoryStatus">GitRepositoryStatus</a>,
<a href="#source.fluxcd.io/v1alpha1.HelmChartStatus">HelmChartStatus</a>, <a href="#source.toolkit.fluxcd.io/v1alpha1.HelmChartStatus">HelmChartStatus</a>,
<a href="#source.fluxcd.io/v1alpha1.HelmRepositoryStatus">HelmRepositoryStatus</a>) <a href="#source.toolkit.fluxcd.io/v1alpha1.HelmRepositoryStatus">HelmRepositoryStatus</a>)
</p> </p>
<p>SourceCondition contains condition information for a source.</p> <p>SourceCondition contains condition information for a source.</p>
<div class="md-typeset__scrollwrap"> <div class="md-typeset__scrollwrap">

2
docs/spec/v1alpha1/README.md
View File

@ -1,4 +1,4 @@
# source.fluxcd.io/v1alpha1 # source.toolkit.fluxcd.io/v1alpha1
This is the v1alpha1 API specification for defining the desired state sources of Kubernetes clusters. This is the v1alpha1 API specification for defining the desired state sources of Kubernetes clusters.

18
docs/spec/v1alpha1/gitrepositories.md
View File

@ -141,7 +141,7 @@ entries may overrule default exclusions.
Another option is to use the `spec.ignore` field, for example: Another option is to use the `spec.ignore` field, for example:
```yaml ```yaml
apiVersion: source.fluxcd.io/v1alpha1 apiVersion: source.toolkit.fluxcd.io/v1alpha1
kind: GitRepository kind: GitRepository
metadata: metadata:
name: podinfo name: podinfo
@ -165,7 +165,7 @@ When specified, `spec.ignore` overrides the default exclusion list.
Pull the master branch of a public repository every minute: Pull the master branch of a public repository every minute:
```yaml ```yaml
apiVersion: source.fluxcd.io/v1alpha1 apiVersion: source.toolkit.fluxcd.io/v1alpha1
kind: GitRepository kind: GitRepository
metadata: metadata:
name: podinfo name: podinfo
@ -177,7 +177,7 @@ spec:
Pull a specific branch: Pull a specific branch:
```yaml ```yaml
apiVersion: source.fluxcd.io/v1alpha1 apiVersion: source.toolkit.fluxcd.io/v1alpha1
kind: GitRepository kind: GitRepository
metadata: metadata:
name: podinfo name: podinfo
@ -191,7 +191,7 @@ spec:
Checkout a specific commit from a branch: Checkout a specific commit from a branch:
```yaml ```yaml
apiVersion: source.fluxcd.io/v1alpha1 apiVersion: source.toolkit.fluxcd.io/v1alpha1
kind: GitRepository kind: GitRepository
metadata: metadata:
name: podinfo name: podinfo
@ -206,7 +206,7 @@ spec:
Pull a specific tag: Pull a specific tag:
```yaml ```yaml
apiVersion: source.fluxcd.io/v1alpha1 apiVersion: source.toolkit.fluxcd.io/v1alpha1
kind: GitRepository kind: GitRepository
metadata: metadata:
name: podinfo name: podinfo
@ -220,7 +220,7 @@ spec:
Pull tag based on a [semver range](https://github.com/blang/semver#ranges): Pull tag based on a [semver range](https://github.com/blang/semver#ranges):
```yaml ```yaml
apiVersion: source.fluxcd.io/v1alpha1 apiVersion: source.toolkit.fluxcd.io/v1alpha1
kind: GitRepository kind: GitRepository
metadata: metadata:
name: podinfo name: podinfo
@ -234,7 +234,7 @@ spec:
HTTPS authentication (requires a secret with `username` and `password` fields): HTTPS authentication (requires a secret with `username` and `password` fields):
```yaml ```yaml
apiVersion: source.fluxcd.io/v1alpha1 apiVersion: source.toolkit.fluxcd.io/v1alpha1
kind: GitRepository kind: GitRepository
metadata: metadata:
name: podinfo name: podinfo
@ -257,7 +257,7 @@ data:
SSH authentication (requires a secret with `identity` and `known_hosts` fields): SSH authentication (requires a secret with `identity` and `known_hosts` fields):
```yaml ```yaml
apiVersion: source.fluxcd.io/v1alpha1 apiVersion: source.toolkit.fluxcd.io/v1alpha1
kind: GitRepository kind: GitRepository
metadata: metadata:
name: podinfo name: podinfo
@ -296,7 +296,7 @@ kubectl create secret generic ssh-credentials \
Verify the OpenPGP signature for the commit that master branch HEAD points to: Verify the OpenPGP signature for the commit that master branch HEAD points to:
```yaml ```yaml
apiVersion: source.fluxcd.io/v1alpha1 apiVersion: source.toolkit.fluxcd.io/v1alpha1
kind: GitRepository kind: GitRepository
metadata: metadata:
name: podinfo name: podinfo

4
docs/spec/v1alpha1/helmcharts.md
View File

@ -69,7 +69,7 @@ const (
Pull a specific chart version every five minutes: Pull a specific chart version every five minutes:
```yaml ```yaml
apiVersion: source.fluxcd.io/v1alpha1 apiVersion: source.toolkit.fluxcd.io/v1alpha1
kind: HelmChart kind: HelmChart
metadata: metadata:
name: redis name: redis
@ -84,7 +84,7 @@ spec:
Pull the latest chart version that matches the sermver range every ten minutes: Pull the latest chart version that matches the sermver range every ten minutes:
```yaml ```yaml
apiVersion: source.fluxcd.io/v1alpha1 apiVersion: source.toolkit.fluxcd.io/v1alpha1
kind: HelmChart kind: HelmChart
metadata: metadata:
name: redis name: redis

4
docs/spec/v1alpha1/helmrepositories.md
View File

@ -67,7 +67,7 @@ const (
Pull the index of a public Helm repository every ten minutes: Pull the index of a public Helm repository every ten minutes:
```yaml ```yaml
apiVersion: source.fluxcd.io/v1alpha1 apiVersion: source.toolkit.fluxcd.io/v1alpha1
kind: HelmRepository kind: HelmRepository
metadata: metadata:
name: stable name: stable
@ -79,7 +79,7 @@ spec:
Pull the index of a private Helm repository every minute: Pull the index of a private Helm repository every minute:
```yaml ```yaml
apiVersion: source.fluxcd.io/v1alpha1 apiVersion: source.toolkit.fluxcd.io/v1alpha1
kind: HelmRepository kind: HelmRepository
metadata: metadata:
name: private name: private