You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: pages/getting-started/advanced-config/sandboxing.md
+62-10Lines changed: 62 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -73,21 +73,60 @@ This is a suitable replacement if you're ok with some data staleness and don't h
73
73
74
74
Lots of enterprises have strict requirements around the docker registries they use, or pull caches that whitelist a limited set of registries. The important images for setting up your own instance are:
75
75
76
-
- ghcr.io/pluralsh/console
77
-
- ghcr.io/pluralsh/kas
78
-
- ghcr.io/pluralsh/deployment-controller
79
-
- ghcr.io/pluralsh/deployment-operator
80
-
- ghcr.io/pluralsh/agentk
81
-
- ghcr.io/pluralsh/git-server (optional if you want to use our vendored git server)
76
+
Plural maintained images:
77
+
Management Cluster:
78
+
- ghcr.io/pluralsh/console
79
+
- ghcr.io/pluralsh/kas
80
+
- ghcr.io/pluralsh/deployment-controller
81
+
- ghcr.io/pluralsh/git-server (optional if you want to use our vendored git server)
82
+
Agent:
83
+
- ghcr.io/pluralsh/agentk
84
+
- ghcr.io/pluralsh/deployment-operator
85
+
86
+
Third party images used by our chart (these are often already vendored in an enterprise environment):
If you plan to utilize Stacks, Sentinels or our async coding agent harness, there are a few other images that are utilize by our deployment-operator that are as follows (they all follow the same versioning as the deployment-operator, although sometimes have tags that are parameterized by tool used):
104
+
105
+
* ghcr.io/pluralsh/harness
106
+
* ghcr.io/pluralsh/sentinel-harness
107
+
* ghcr.io/pluralsh/agent-harness
108
+
109
+
You can see them all [here](https://github.com/orgs/pluralsh/packages?repo_name=deployment-operator).
110
+
111
+
The product experience of all these allow bring-your-own image, but if you configure a pull-through cache for these images or vendor them consistently, you can have Plural auto-wire it against an internal registry with the following CRD:
112
+
113
+
```yaml
114
+
apiVersion: deployments.plural.sh/v1alpha1
115
+
kind: AgentConfiguration
116
+
metadata:
117
+
name: global
118
+
namespace: plrl-deploy-operator
119
+
spec:
120
+
baseRegistryURL: your.enterprise.registry
121
+
```
122
+
123
+
See more about this resource [here](/overview/agent-api-reference#agentconfigurationspec)
83
124
84
125
{% callout severity="info" %}
85
126
All of these images follow semver, and are also published to `gcr.io` and `docker.io` as well for convenience, in the event that either of those are eligible for internal pull-through caches. The redis instance is not meaningfully customized and any bitnami or equivalent redis container image can theoretically work there.
86
127
{% /callout %}
87
128
88
-
The first three will be configured in the main console chart and are installed once in your management cluster, the latter two are needed for your deployment agent pod, and require a bit more advanced configuration to manage them in bulk.
89
-
90
-
A starter values file for configuring images for your console in the management cluster would be:
129
+
To configure your *management cluster* helm values, use the following template:
description: How To Add An Existing Cluster to Your Plural Instance
4
+
---
5
+
6
+
Adding a new cluster to Plural is very simple, it's simply a matter of installing our agent onto any end cluster, and usually follows two paths:
7
+
8
+
1. Leverage our CLI which wraps a full install including registering with your Plural api and helm installing the agent on the cluster
9
+
2. Use our terraform provider to wrap this whole process as Infrastructure as Code
10
+
11
+
Both are functional and fully supported, and execute equivalent code under the hood. If you set up your install with `plural up` we've already wrapped a ton of fully functional GitOps workflows for you, and those usually are more featureful workflows than doing this manually. If you want to read more about them, feel free to look at the guide here: [Create a Workload Cluster](/getting-started/how-to-use/workload-cluster).
12
+
13
+
{% callout severity="info" %}
14
+
We strongly recommend leveraging a IaC based pattern, since it'll allow you to export terraform state into Plural for re-use and maximizes reproducibility
15
+
{% /callout %}
16
+
17
+
18
+
## Onboard a cluster with our CLI
19
+
20
+
To add a new cluster simply run with a valid kubeconfig set up locally:
21
+
22
+
```sh
23
+
plural cd clusters bootstrap --name {your-cluster-name} --tag {tag}={value} --tag {tag2}={value2}
24
+
```
25
+
26
+
To see all CLI options, feel free to use:
27
+
28
+
```sh
29
+
plural cd clusters bootstrap --help
30
+
```
31
+
32
+
If you need to reinstall our agent for any reason, just use:
33
+
34
+
```sh
35
+
plural cd clusters reinstall @{cluster-handle}
36
+
```
37
+
38
+
{% callout severity="info" %}
39
+
The `@` character is required, as it allows our CLI to differentiate names from IDs.
40
+
41
+
You should also address the cluster by handle in the event name is not unique in your system.
42
+
{% /callout %}
43
+
44
+
## Onboard a cluster with our Terraform Provider
45
+
46
+
Here is a basic terraform snippet that shows how you can use our Terraform provider to install our agent
47
+
48
+
```terraform
49
+
resource "plural_cluster" "this" {
50
+
handle = var.cluster
51
+
name = var.cluster
52
+
tags = {
53
+
fleet = var.fleet
54
+
tier = var.tier
55
+
}
56
+
57
+
# metadata attaching useful cluster-level state in Plural to use for service templating
This makes it easy to wrap Plural setup in existing IaC codebases and ensure full repeatability.
91
+
92
+
The metadata block is of importance as well, as it drives our helm + yaml templating experience within Plural CD. You can see some guides around that [here](/plural-features/continuous-deployment/service-templating).
0 commit comments