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: docs/platform/guides/cluster-management/add-cluster/import-vendor-managed.md
+15-1Lines changed: 15 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,14 +21,28 @@ section_menu_id: guides
21
21
22
22
### Select Credential
23
23
24
-
3. Choose a credential with permission to access and import the cluster, then click `Next`. To create one, use the `+Create Credential` button (see [Credentials](../../account-management/kubernetes/credentials.html)).
24
+
3. Choose a credential with permission to access and import the cluster, then click `Next`. To create one, use the `+Create Credential` button (see [Credentials](../../account-management/kubernetes/credentials.md)).
25
+
26
+
27
+
28
+
Copy file name to clipboardExpand all lines: docs/platform/guides/cluster-management/add-cluster/self-managed/import-public.md
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,10 +19,14 @@ section_menu_id: guides
19
19
20
20
2. In the `Self Managed` section, choose the public cluster option.
21
21
22
+
23
+
22
24
### Provide Kubeconfig
23
25
24
26
3. Provide the kubeconfig for your cluster.
25
27
28
+
The **Helm** group in the Cluster UI sidebar gives you full visibility into your cluster's Helm ecosystem. It has three pages — Releases, HelmRelease, and HelmChart — covering deployed releases, FluxCD-managed releases, and chart sources respectively.
15
16
16
-
Platform Console's Helm Chart Management lets you manage Helm releases within your Kubernetes clusters — installing new charts, modifying existing releases, and rolling back versions from the UI.
17
+
## Open the Helm Section
17
18
18
-
## Accessing Helm Chart Management
19
+
1. Navigate to the [Platform Console](https://console.appscode.com).
20
+
2. Click on your imported cluster to open its Cluster Overview page.
21
+
3. In the left sidebar, click **Helm** to expand it.
19
22
20
-
To navigate to the Helm Chart Management page:
23
+
---
24
+
25
+
## Releases
26
+
27
+
The Releases page lists all Helm v3 releases currently deployed in your cluster — everything installed via `helm install`, regardless of how it got there. This is the primary page to check what is running, what version is deployed, and whether the release is in a healthy state.
28
+
29
+
Use this page to get a quick overview of all deployed charts, check release status, or install a new chart using the **+ Install Chart** button.
30
+
31
+
Lists every release with its **Name**, **Namespace**, **Status** (e.g. deployed, failed), **Version**, and **Age**. Use the **Select All** and **All Namespaces** dropdowns to filter the list.
32
+
33
+
34
+
35
+
---
36
+
37
+
## HelmRelease
21
38
22
-
1. From the [Platform Console](https://console.appscode.com), click on your imported cluster to go to the Cluster Overview page.
23
-
2. In the left sidebar, under **Helm**, select **Releases** to access the Helm Chart Management page.
39
+
A HelmRelease is a FluxCD resource that declaratively manages a Helm chart installation. The Platform Console tracks every HelmRelease and shows its reconciliation state, so you can see whether a GitOps-driven installation or upgrade succeeded or is still in progress.
24
40
25
-
## Helm Chart Management Features
41
+
Use this page to check FluxCD-managed release health, spot failed reconciliations, or create a new HelmRelease from the UI.
26
42
27
-
### Install New Charts
43
+
Lists every HelmRelease with its **Namespace**, **Age**, **Ready** status, and a **Status** message showing the last Helm operation result. Click **+ Create HelmRelease** to define a new one.
28
44
29
-
1.**Choose Chart Source:** Select a chart source from publicly available URLs or provide a custom URL.
30
-
2.**Select Chart and Version:** Browse and choose the desired chart and version.
31
-
3.**Customize Installation:** Provide a custom release name, namespace, and specify a custom values file during installation.
45
+
46
+
47
+
---
48
+
49
+
## HelmChart
50
+
51
+
A HelmChart is a FluxCD resource that sources a specific chart and version from a HelmRepository. Each HelmRelease references a HelmChart behind the scenes. This page tells you which charts are being pulled, from where, and whether the source is reachable and up to date.
52
+
53
+
Use this page to verify chart versions in use, check that chart sources are resolving correctly, or create a new HelmChart resource.
54
+
55
+
Lists every HelmChart with its **Namespace**, **Annotations**, **Age**, **Chart** name, **Version**, **Source Kind**, **Source Name**, **Ready** state, and **Status**. Click **+ Create HelmChart** to add a new chart source.
56
+
57
+
58
+
59
+
---
32
60
33
-
### Interact with Existing Releases
61
+
##Quick Reference
34
62
35
-
-**Modify Releases:** Adjust existing Helm releases based on evolving requirements.
36
-
-**Rollback to Previous Versions:** Revert to previous versions of Helm releases if needed.
63
+
| Task | How to do it |
64
+
|---|---|
65
+
| View all deployed releases | Click **Releases** under the Helm group |
66
+
| Install a new chart | Click **+ Install Chart** on the Releases page |
67
+
| Check FluxCD-managed release health | Click **HelmRelease** under the Helm group |
68
+
| View chart sources | Click **HelmChart** under the Helm group |
69
+
| Create a new FluxCD release | Click **+ Create HelmRelease** on the HelmRelease page |
The Kubernetes Workload Management section in the Platform Console manages Kubernetes resources.
15
+
The **Workloads** group in the Cluster UI sidebar is where you browse and manage everything that runs application containers — Deployments, Pods, Jobs, and the other standard Kubernetes workload types.
16
+
17
+
## Open the Workloads Section
17
18
18
19
1. Navigate to the [Platform Console](https://console.appscode.com).
19
-
2. Click on your imported cluster to access the Cluster Overview page.
20
+
2. Click on your imported cluster to open its Cluster Overview page.
21
+
3. In the left sidebar, click **Workloads** to expand it.
22
+
23
+
Every list page in this group follows the same layout: a 🔍 search box, an **All Namespaces** filter dropdown, and a green **+ Create** button top-right.
24
+
25
+
---
26
+
27
+
## Deployments
28
+
29
+
A Deployment keeps a set number of identical app copies running and handles rolling updates — it's the standard way to run and update a stateless app. Use this page when you need to check rollout status, scale an app up/down, or push a new image version.
30
+
31
+
Lists every Deployment with its Namespace, Pods (ready count), Images, and Age. Click a row to view or edit it; use **+ Create** to deploy a new one.
32
+
33
+
20
34
21
-
## Cluster Overview Page
35
+
---
22
36
23
-
The Cluster Overview page provides essential information about your cluster, including a node list, available FeatureSets, and their respective statuses (enabled or disabled).
37
+
## Replica Sets
24
38
25
-
## Left Sidebar Navigation
39
+
A Replica Set's only job is to keep a fixed number of Pod copies alive. You rarely create these by hand — a Deployment creates and manages one for you behind the scenes. Check this page when troubleshooting why a Deployment isn't scaling the way you expect.
26
40
27
-
The left sidebar presents a variety of options for managing Kubernetes workloads:
41
+
Lists every Replica Set with its Namespace, Pods, Images, and Age.
28
42
29
-
-**Kubernetes:**
30
-
- Overview
31
-
- Nodes
43
+
32
44
33
-
-**Workloads:**
34
-
- Deployments
35
-
- Replica Sets
36
-
- Replication Sets
37
-
- Stateful Sets
38
-
- Daemon Sets
39
-
- Jobs
40
-
- Cron Jobs
41
-
- Pods
45
+
---
42
46
43
-
-**Helm:**
44
-
- Releases
47
+
## Replication Controllers
45
48
46
-
-**Datastore:**
47
-
- Postgres
48
-
- Elasticsearch
49
-
- MongoDB (and others managed by KubeDB)
49
+
The older, legacy way to keep a fixed number of Pod copies running — same idea as a Replica Set, kept for backward compatibility. New workloads should use Deployments instead; you'd only see entries here on older setups.
50
50
51
-
-**Service & Discovery:**
52
-
- Services
53
-
- Ingresses
54
-
- Network Policies
51
+
Lists every Replication Controller with its Namespace, Pods, Images, and Age. Click **+ Create ReplicationController** to add one.
55
52
56
-
-**Config:**
57
-
- Config Maps
58
-
- Secrets
53
+
59
54
60
-
-**Storage:**
61
-
- Persistent Volume Claims
62
-
- Persistent Volumes
63
-
- Storage Classes
55
+
---
64
56
65
-
-**Monitoring:**
66
-
- Alertmanager
67
-
- PodMonitor
68
-
- Prometheus
69
-
- ServiceMonitor
70
-
- PrometheusRule
57
+
## Stateful Sets
71
58
72
-
-**Security:**
73
-
- Service Accounts
74
-
- Policy
75
-
- Gatekeeper Report
59
+
For apps where each Pod needs a stable identity and its own storage — databases, queues, anything that can't just be swapped for an identical copy. Use this when running stateful services that care about pod order or persistent data.
76
60
77
-
-**Admin:**
78
-
- Namespaces
79
-
- Resource Quotas
80
-
- Cluster Roles
81
-
- Roles
82
-
- CSI Drivers
61
+
Lists every Stateful Set with its Namespace, Pods, Images, and Age.
83
62
84
-
You can customize the left sidebar by clicking the ⚙️ icon on the navbar, navigating to the Cluster Settings page, and selecting the `Sidebar` tab. Refer to the [Sidebar Management Documentation](cluster-sidebar.md) for more details.
63
+
64
+
65
+
---
85
66
86
-
## Resource Management
67
+
## Daemon Sets
87
68
88
-
Select any resource from the left sidebar to list the resources. From there, you can go to the resource details page. The available options for each resource include:
69
+
Runs one copy of a Pod on every node automatically — typically used for cluster-wide infrastructure like log collectors or monitoring agents that need to run everywhere. Check this page to confirm a node-wide agent has rolled out to all nodes.
70
+
71
+
Lists every Daemon Set with its Namespace, Pods, Dsired, Current-Scheduled, Up-to-date, Node Selector, Images, and Age — the Desired/Current/Up-to-date columns show rollout progress at a glance.
72
+
73
+
74
+
75
+
---
89
76
90
-
- Basic Overview
91
-
- Resource Components
92
-
- Related Resources
93
-
- Events
94
-
- Graph of Connected Resources
95
-
- Resource Manifest
77
+
## Jobs
78
+
79
+
A Job runs a task once until it completes — a backup, a migration script, a one-off batch process — then stops, unlike a Deployment which runs forever. Use this page to check whether a one-off task finished and how long it took.
80
+
81
+
Lists every Job with its Namespace, Annotations, Completions, Duration, Images, and Age.
82
+
83
+
84
+
85
+
---
86
+
87
+
## Cron Jobs
88
+
89
+
A Cron Job runs a Job on a repeating schedule — like a nightly backup or a recurring cleanup task — so you don't have to trigger it manually each time. Use the **Suspend** state here to pause a recurring task without deleting it.
90
+
91
+
Lists every Cron Job with its Namespace, Annotations, Schedule, Suspend, Active, Last Schedule, Images, and Age — the Schedule column shows the cron expression.
92
+
93
+
94
+
95
+
---
96
+
97
+
## Pods
98
+
99
+
A Pod is the actual running container(s) — the smallest unit in Kubernetes. Every Deployment, StatefulSet, Job, etc. above ultimately creates Pods to do the real work. This is the page to check when you need to see real-time container health or debug a crash.
100
+
101
+
Lists every Pod with its Namespace, Ready, Status, Restarts, IP, Images, and Age — the only Workloads item with these extra live-state columns, useful for spotting crashing or restarting containers.
102
+
103
+
104
+
105
+
---
96
106
97
-
The `Datastore` section is dedicated to KubeDB, an AppsCode product, for managing various types of databases. You can create new databases, explore overviews, components, connected resources, and manifests for each database.
107
+
## Quick Reference
98
108
99
-
You can also create new resources directly from any resource list page by clicking the `➕ Create` button, filling out the form, and submitting to create the resource.
109
+
| Task | How to do it |
110
+
|---|---|
111
+
| Open the Workloads view | Click your cluster on the Platform Console → click **Workloads** in the left sidebar |
112
+
| List a workload type | Click its name under the Workloads group (e.g. Deployments, Pods) |
113
+
| Filter by namespace | Use the **All Namespaces** dropdown on any list page |
114
+
| Create a new workload | Click **+ Create** on the resource's list page |
0 commit comments