diff --git a/docs/ref-configuration.md b/docs/ref-configuration.md index aa492cfec..c8d357f0a 100644 --- a/docs/ref-configuration.md +++ b/docs/ref-configuration.md @@ -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 diff --git a/docs/ref-crd-gitrepo.md b/docs/ref-crd-gitrepo.md new file mode 100644 index 000000000..025535489 --- /dev/null +++ b/docs/ref-crd-gitrepo.md @@ -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). diff --git a/docs/ref-fleet-yaml.md b/docs/ref-fleet-yaml.md new file mode 100644 index 000000000..018874a6e --- /dev/null +++ b/docs/ref-fleet-yaml.md @@ -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). diff --git a/sidebars.js b/sidebars.js index 939b72873..ea5c37320 100644 --- a/sidebars.js +++ b/sidebars.js @@ -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", ], }, ],