Add fleet.yaml and GitRepo into reference

This should make it easier to access the existing texts.
This commit is contained in:
Mario Manno 2022-11-29 17:03:17 +01:00
parent ff98a2109d
commit e0b424d820
4 changed files with 21 additions and 5 deletions

View File

@ -16,7 +16,7 @@ The controllers can be started with these environment variables:
* `CATTLE_DEV_MODE` - used to debug wrangler, not usable
* `FLEET_CLUSTER_ENQUEUE_DELAY` - tune how often non-ready clusters are checked
* `FLEET_CPU_PPROF_PERIOD` - used to turn on [performance profiling](https://github.com/rancher/fleet/blob/master/DEVELOPING.md#examining-performance-issues)
* `FLEET_CPU_PPROF_PERIOD` - used to turn on [performance profiling](https://github.com/rancher/fleet/blob/master/docs/performance.md)
## Configuration

7
docs/ref-crd-gitrepo.md Normal file
View File

@ -0,0 +1,7 @@
# GitRepo CRD
The GitRepo resource describes git repositories, how to access them and where the bundles are located.
A full reference with explanations can be found in [Adding a GitRepo](./gitrepo-add#create-gitrepo-instance).
The content of the resource corresponds to the [GitRepoSpec](./ref-crds#gitrepospec).

7
docs/ref-fleet-yaml.md Normal file
View File

@ -0,0 +1,7 @@
# fleet.yaml
The `fleet.yaml` file adds options to a bundle. Any directory with a `fleet.yaml` is automatically turned into bundle.
A full reference with explanations can be found in [Expected Repo Structure](./gitrepo-structure.md#fleetyaml).
The content of the fleet.yaml corresponds to the [BundleSpec](./ref-crds#bundlespec).

View File

@ -68,12 +68,15 @@ module.exports = {
type: 'category',
label: 'Reference',
items:[
'ref-configuration',
'ref-components',
'ref-crd-gitrepo',
'ref-fleet-yaml',
'ref-bundle-stages',
'ref-resources',
'ref-components',
'ref-namespaces',
'ref-resources',
'ref-configuration',
'ref-registration',
"ref-crds",
{
'CLI':
[
@ -88,7 +91,6 @@ module.exports = {
{type: 'doc', id: 'cli/fleet-controller/fleet-manager'},
],
},
"ref-crds",
],
},
],