rancher
/
fleet-docs
mirror of https://github.com/rancher/fleet-docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #175 from rancher/fleet-manager-to-controller 

Rename Fleet manager as Fleet controller
This commit is contained in:
Klaus Kämpf 2024-08-21 15:00:12 +02:00 committed by GitHub
parent 4c6a4222ee b08f030f17
commit 0cb59e679e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
14 changed files with 2811 additions and 1998 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/architecture.md
View File

@ -1,23 +1,23 @@
# Architecture # Architecture
Fleet has two primary components. The Fleet manager and the cluster agents. These Fleet has two primary components. The Fleet controller and the cluster agents. These
components work in a two-stage pull model. The Fleet manager will pull from git and the components work in a two-stage pull model. The Fleet controller will pull from git and the
cluster agents will pull from the Fleet manager. cluster agents will pull from the Fleet controller.
## Fleet Manager ## Fleet Controller
The Fleet manager is a set of Kubernetes controllers running in any standard Kubernetes The Fleet controller is a set of Kubernetes controllers running in any standard Kubernetes
cluster. The only API exposed by the Fleet manager is the Kubernetes API, there is no cluster. The only API exposed by the Fleet controller is the Kubernetes API, there is no
custom API for the fleet controller. custom API for the fleet controller.
## Cluster Agents ## Cluster Agents
One cluster agent runs in each cluster and is responsible for talking to the Fleet manager. One cluster agent runs in each cluster and is responsible for talking to the Fleet controller.
The only communication from cluster to Fleet manager is by this agent and all communication The only communication from cluster to Fleet controller is by this agent and all communication
goes from the managed cluster to the Fleet manager. The fleet manager does not initiate goes from the managed cluster to the Fleet controller. The fleet manager does not initiate
connections to downstream clusters. This means managed clusters can run in private networks and behind connections to downstream clusters. This means managed clusters can run in private networks and behind
NATs. The only requirement is the cluster agent needs to be able to communicate with the NATs. The only requirement is the cluster agent needs to be able to communicate with the
Kubernetes API of the cluster running the Fleet manager. The one exception to this is if you use Kubernetes API of the cluster running the Fleet controller. The one exception to this is if you use
the [manager initiated](./cluster-registration.md#manager-initiated) cluster registration flow. This is not required, but the [manager initiated](./cluster-registration.md#manager-initiated) cluster registration flow. This is not required, but
an optional pattern. an optional pattern.
@ -27,7 +27,7 @@ the agent checks in, as it stands right now they will always attempt to connect.
## Security ## Security
The Fleet manager dynamically creates service accounts, manages their RBAC and then gives the The Fleet controller dynamically creates service accounts, manages their RBAC and then gives the
tokens to the downstream clusters. Clusters are registered by optionally expiring cluster registration tokens. tokens to the downstream clusters. Clusters are registered by optionally expiring cluster registration tokens.
The cluster registration token is used only during the registration process to generate a credential specific The cluster registration token is used only during the registration process to generate a credential specific
to that cluster. After the cluster credential is established the cluster "forgets" the cluster registration to that cluster. After the cluster credential is established the cluster "forgets" the cluster registration

14
docs/cli/fleet-controller/fleet-manager.md → docs/cli/fleet-controller/fleetcontroller.md
View File

@ -1,13 +1,13 @@
--- ---
title: "" title: ""
sidebar_label: "fleet-manager" sidebar_label: "fleetcontroller"
--- ---
## fleet-manager ## fleetcontroller
``` ```
fleet-manager [flags] fleetcontroller [flags]
``` ```
### Options ### Options
@ -17,7 +17,7 @@ fleet-manager [flags]
--debug-level int If debugging is enabled, set klog -v=X --debug-level int If debugging is enabled, set klog -v=X
--disable-gitops disable gitops components --disable-gitops disable gitops components
--disable-metrics disable metrics --disable-metrics disable metrics
-h, --help help for fleet-manager -h, --help help for fleetcontroller
--kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster.
--namespace string namespace to watch (default "cattle-fleet-system") --namespace string namespace to watch (default "cattle-fleet-system")
--shard-id string only manage resources labeled with a specific shard ID --shard-id string only manage resources labeled with a specific shard ID
@ -30,7 +30,7 @@ fleet-manager [flags]
### SEE ALSO ### SEE ALSO
* [fleet-manager agentmanagement](./fleet-manager_agentmanagement) - * [fleetcontroller agentmanagement](./fleetcontroller_agentmanagement) -
* [fleet-manager cleanup](./fleet-manager_cleanup) - * [fleetcontroller cleanup](./fleetcontroller_cleanup) -
* [fleet-manager gitjob](./fleet-manager_gitjob) - * [fleetcontroller gitjob](./fleetcontroller_gitjob) -

8
versioned_docs/version-0.10/cli/fleet-controller/fleet-manager_agentmanagement.md → docs/cli/fleet-controller/fleetcontroller_agentmanagement.md
View File

@ -1,13 +1,13 @@
--- ---
title: "" title: ""
sidebar_label: "fleet-manager agentmanagement" sidebar_label: "fleetcontroller agentmanagement"
--- ---
## fleet-manager agentmanagement ## fleetcontroller agentmanagement
``` ```
fleet-manager agentmanagement [flags] fleetcontroller agentmanagement [flags]
``` ```
### Options ### Options
@ -28,5 +28,5 @@ fleet-manager agentmanagement [flags]
### SEE ALSO ### SEE ALSO
* [fleet-manager](./fleet-manager) - * [fleetcontroller](./fleetcontroller) -

8
docs/cli/fleet-controller/fleet-manager_cleanup.md → docs/cli/fleet-controller/fleetcontroller_cleanup.md
View File

@ -1,13 +1,13 @@
--- ---
title: "" title: ""
sidebar_label: "fleet-manager cleanup" sidebar_label: "fleetcontroller cleanup"
--- ---
## fleet-manager cleanup ## fleetcontroller cleanup
``` ```
fleet-manager cleanup [flags] fleetcontroller cleanup [flags]
``` ```
### Options ### Options
@ -27,5 +27,5 @@ fleet-manager cleanup [flags]
### SEE ALSO ### SEE ALSO
* [fleet-manager](./fleet-manager) - * [fleetcontroller](./fleetcontroller) -

8
versioned_docs/version-0.10/cli/fleet-controller/fleet-manager_gitjob.md → docs/cli/fleet-controller/fleetcontroller_gitjob.md
View File

@ -1,13 +1,13 @@
--- ---
title: "" title: ""
sidebar_label: "fleet-manager gitjob" sidebar_label: "fleetcontroller gitjob"
--- ---
## fleet-manager gitjob ## fleetcontroller gitjob
``` ```
fleet-manager gitjob [flags] fleetcontroller gitjob [flags]
``` ```
### Options ### Options
@ -34,5 +34,5 @@ fleet-manager gitjob [flags]
### SEE ALSO ### SEE ALSO
* [fleet-manager](./fleet-manager) - * [fleetcontroller](./fleetcontroller) -

6
package.json
View File

@ -14,8 +14,8 @@
"write-heading-ids": "docusaurus write-heading-ids" "write-heading-ids": "docusaurus write-heading-ids"
}, },
"dependencies": { "dependencies": {
"@docusaurus/core": "^2.3.1", "@docusaurus/core": "^3.5.2",
"@docusaurus/preset-classic": "^2.3.1", "@docusaurus/preset-classic": "^3.5.2",
"@mdx-js/react": "^1.6.22", "@mdx-js/react": "^1.6.22",
"clsx": "^1.2.1", "clsx": "^1.2.1",
"prism-react-renderer": "^1.3.5", "prism-react-renderer": "^1.3.5",
@ -23,7 +23,7 @@
"react-dom": "^17.0.2" "react-dom": "^17.0.2"
}, },
"devDependencies": { "devDependencies": {
"@docusaurus/module-type-aliases": "^2.3.1" "@docusaurus/module-type-aliases": "^3.5.2"
}, },
"browserslist": { "browserslist": {
"production": [ "production": [

7
sidebars.js
View File

@ -64,9 +64,10 @@ module.exports = {
{type: 'doc', id: 'cli/fleet-cli/fleet_deploy'}, {type: 'doc', id: 'cli/fleet-cli/fleet_deploy'},
{type: 'doc', id: 'cli/fleet-cli/fleet_target'}, {type: 'doc', id: 'cli/fleet-cli/fleet_target'},
{type: 'doc', id: 'cli/fleet-cli/fleet_test'}, {type: 'doc', id: 'cli/fleet-cli/fleet_test'},
{type: 'doc', id: 'cli/fleet-controller/fleet-manager'}, {type: 'doc', id: 'cli/fleet-controller/fleetcontroller'},
{type: 'doc', id: 'cli/fleet-controller/fleet-manager_agentmanagement'}, {type: 'doc', id: 'cli/fleet-controller/fleetcontroller_agentmanagement'},
{type: 'doc', id: 'cli/fleet-controller/fleet-manager_cleanup'}, {type: 'doc', id: 'cli/fleet-controller/fleetcontroller_cleanup'},
{type: 'doc', id: 'cli/fleet-controller/fleetcontroller_gitjob'},
], ],
}, },
{type:'doc', id:'ref-status-fields'}, {type:'doc', id:'ref-status-fields'},

22
versioned_docs/version-0.10/architecture.md
View File

@ -1,23 +1,23 @@
# Architecture # Architecture
Fleet has two primary components. The Fleet manager and the cluster agents. These Fleet has two primary components. The Fleet controller and the cluster agents. These
components work in a two-stage pull model. The Fleet manager will pull from git and the components work in a two-stage pull model. The Fleet controller will pull from git and the
cluster agents will pull from the Fleet manager. cluster agents will pull from the Fleet controller.
## Fleet Manager ## Fleet Controller
The Fleet manager is a set of Kubernetes controllers running in any standard Kubernetes The Fleet controller is a set of Kubernetes controllers running in any standard Kubernetes
cluster. The only API exposed by the Fleet manager is the Kubernetes API, there is no cluster. The only API exposed by the Fleet controller is the Kubernetes API, there is no
custom API for the fleet controller. custom API for the fleet controller.
## Cluster Agents ## Cluster Agents
One cluster agent runs in each cluster and is responsible for talking to the Fleet manager. One cluster agent runs in each cluster and is responsible for talking to the Fleet controller.
The only communication from cluster to Fleet manager is by this agent and all communication The only communication from cluster to Fleet controller is by this agent and all communication
goes from the managed cluster to the Fleet manager. The fleet manager does not initiate goes from the managed cluster to the Fleet controller. The fleet manager does not initiate
connections to downstream clusters. This means managed clusters can run in private networks and behind connections to downstream clusters. This means managed clusters can run in private networks and behind
NATs. The only requirement is the cluster agent needs to be able to communicate with the NATs. The only requirement is the cluster agent needs to be able to communicate with the
Kubernetes API of the cluster running the Fleet manager. The one exception to this is if you use Kubernetes API of the cluster running the Fleet controller. The one exception to this is if you use
the [manager initiated](./cluster-registration.md#manager-initiated) cluster registration flow. This is not required, but the [manager initiated](./cluster-registration.md#manager-initiated) cluster registration flow. This is not required, but
an optional pattern. an optional pattern.
@ -27,7 +27,7 @@ the agent checks in, as it stands right now they will always attempt to connect.
## Security ## Security
The Fleet manager dynamically creates service accounts, manages their RBAC and then gives the The Fleet controller dynamically creates service accounts, manages their RBAC and then gives the
tokens to the downstream clusters. Clusters are registered by optionally expiring cluster registration tokens. tokens to the downstream clusters. Clusters are registered by optionally expiring cluster registration tokens.
The cluster registration token is used only during the registration process to generate a credential specific The cluster registration token is used only during the registration process to generate a credential specific
to that cluster. After the cluster credential is established the cluster "forgets" the cluster registration to that cluster. After the cluster credential is established the cluster "forgets" the cluster registration

14
versioned_docs/version-0.10/cli/fleet-controller/fleet-manager.md → versioned_docs/version-0.10/cli/fleet-controller/fleetcontroller.md
View File

@ -1,13 +1,13 @@
--- ---
title: "" title: ""
sidebar_label: "fleet-manager" sidebar_label: "fleetcontroller"
--- ---
## fleet-manager ## fleetcontroller
``` ```
fleet-manager [flags] fleetcontroller [flags]
``` ```
### Options ### Options
@ -17,7 +17,7 @@ fleet-manager [flags]
--debug-level int If debugging is enabled, set klog -v=X --debug-level int If debugging is enabled, set klog -v=X
--disable-gitops disable gitops components --disable-gitops disable gitops components
--disable-metrics disable metrics --disable-metrics disable metrics
-h, --help help for fleet-manager -h, --help help for fleetcontroller
--kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster. --kubeconfig string Paths to a kubeconfig. Only required if out-of-cluster.
--namespace string namespace to watch (default "cattle-fleet-system") --namespace string namespace to watch (default "cattle-fleet-system")
--shard-id string only manage resources labeled with a specific shard ID --shard-id string only manage resources labeled with a specific shard ID
@ -30,7 +30,7 @@ fleet-manager [flags]
### SEE ALSO ### SEE ALSO
* [fleet-manager agentmanagement](./fleet-manager_agentmanagement) - * [fleetcontroller agentmanagement](./fleetcontroller_agentmanagement) -
* [fleet-manager cleanup](./fleet-manager_cleanup) - * [fleetcontroller cleanup](./fleetcontroller_cleanup) -
* [fleet-manager gitjob](./fleet-manager_gitjob) - * [fleetcontroller gitjob](./fleetcontroller_gitjob) -

8
docs/cli/fleet-controller/fleet-manager_agentmanagement.md → versioned_docs/version-0.10/cli/fleet-controller/fleetcontroller_agentmanagement.md
View File

@ -1,13 +1,13 @@
--- ---
title: "" title: ""
sidebar_label: "fleet-manager agentmanagement" sidebar_label: "fleetcontroller agentmanagement"
--- ---
## fleet-manager agentmanagement ## fleetcontroller agentmanagement
``` ```
fleet-manager agentmanagement [flags] fleetcontroller agentmanagement [flags]
``` ```
### Options ### Options
@ -28,5 +28,5 @@ fleet-manager agentmanagement [flags]
### SEE ALSO ### SEE ALSO
* [fleet-manager](./fleet-manager) - * [fleetcontroller](./fleetcontroller) -

8
versioned_docs/version-0.10/cli/fleet-controller/fleet-manager_cleanup.md → versioned_docs/version-0.10/cli/fleet-controller/fleetcontroller_cleanup.md
View File

@ -1,13 +1,13 @@
--- ---
title: "" title: ""
sidebar_label: "fleet-manager cleanup" sidebar_label: "fleetcontroller cleanup"
--- ---
## fleet-manager cleanup ## fleetcontroller cleanup
``` ```
fleet-manager cleanup [flags] fleetcontroller cleanup [flags]
``` ```
### Options ### Options
@ -27,5 +27,5 @@ fleet-manager cleanup [flags]
### SEE ALSO ### SEE ALSO
* [fleet-manager](./fleet-manager) - * [fleetcontroller](./fleetcontroller) -

8
docs/cli/fleet-controller/fleet-manager_gitjob.md → versioned_docs/version-0.10/cli/fleet-controller/fleetcontroller_gitjob.md
View File

@ -1,13 +1,13 @@
--- ---
title: "" title: ""
sidebar_label: "fleet-manager gitjob" sidebar_label: "fleetcontroller gitjob"
--- ---
## fleet-manager gitjob ## fleetcontroller gitjob
``` ```
fleet-manager gitjob [flags] fleetcontroller gitjob [flags]
``` ```
### Options ### Options
@ -34,5 +34,5 @@ fleet-manager gitjob [flags]
### SEE ALSO ### SEE ALSO
* [fleet-manager](./fleet-manager) - * [fleetcontroller](./fleetcontroller) -

6
versioned_sidebars/version-0.10-sidebars.json
View File

@ -114,15 +114,15 @@
}, },
{ {
"type": "doc", "type": "doc",
"id": "cli/fleet-controller/fleet-manager" "id": "cli/fleet-controller/fleetcontroller"
}, },
{ {
"type": "doc", "type": "doc",
"id": "cli/fleet-controller/fleet-manager_agentmanagement" "id": "cli/fleet-controller/fleetcontroller_agentmanagement"
}, },
{ {
"type": "doc", "type": "doc",
"id": "cli/fleet-controller/fleet-manager_cleanup" "id": "cli/fleet-controller/fleetcontroller_cleanup"
} }
] ]
}, },

4670
yarn.lock
View File

File diff suppressed because it is too large Load Diff