Skip to content

Commit

Permalink
fix: updating documentation for release-3-2
Browse files Browse the repository at this point in the history
  • Loading branch information
karl-cardenas-coding committed Feb 27, 2023
1 parent 1e8608b commit df43ace
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -473,4 +473,4 @@ To create a new release, use the following steps:
The semantic-release logic and the GitHub Actions in the [release.yaml](.github/workflows/release.yaml) will ensure the new release tag is created.
> **Warning**
> Do not use `fix` or other semantic-release key words in regular commit messages. Use `docs: ....` for regular documentation commits.
> Do not use `fix` or other semantic-release key words in regular commit messages. Use the commit message prefix `docs: yourMessageHere` for regular documentation commits.
12 changes: 6 additions & 6 deletions content/docs/04-clusters.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ Overall health is computed based on the following factors:

Palette provides health check information for your workload clusters. This information is a value add to the cluster monitoring activities. In case a cluster goes to an unhealthy state, the last received healthy heartbeat can help you in troubleshooting.

![Cluster_Health_Heart_Beat](doc_cluster_clusters-cluster-heart-beat.png)
![Cluster_Health_Heart_Beat](/doc_cluster_clusters-cluster-heart-beat.png)

* **Node Conditions** - Kubernetes maintains the status for each cluster node in the form of conditions such as DiskPressure, MemoryPressure, or NetworkUnavailable. Palette monitors these conditions and reports back to the management console. Any node condition indicating a problem with the node, results in an unhealthy status for the cluster.

Expand All @@ -110,15 +110,15 @@ Palette continuously monitors cluster resources and reports the usage for the cl

* **Memory Requests** - Total memory requested across all pods.

![Cluster Update Details](04-clusters/cluster_usage_metrics.png)
![Cluster Update Details](/cluster_usage_metrics.png)

Additionally, usage metrics for individual nodes and node conditions are accessible from the Node Details page.

# Application Services

Palette enables quick access to the application services installed on the Kubernetes clusters by providing a link to those on the management console. These include the applications and services deployed through Palette and the ones deployed through any other means. Services are monitored on an ongoing basis, and all services of the type LoadBalancer or NodePort are displayed on the management console.

![Cluster Update Details](04-clusters/cluster_services.png "#width=500px")
![Cluster Update Details](/cluster_services.png "#width=500px")

# Troubleshooting

Expand All @@ -140,7 +140,7 @@ Examples include:

The active condition indicates what task Palette orchestration system is trying to perform. If a task fails, the condition is marked as *failed*, with relevant error messages. Reconciliation, however, continues behind the scenes, and continuous attempts are made to perform the task. Failed conditions are a great source of troubleshooting provisioning issues.

![Cluster Update Details](04-clusters/cluster_conditions.png "#width=400px")
![Cluster Update Details](/cluster_conditions.png "#width=400px")

For example, failure to create a Virtual Machine in AWS due to the exceeded vCPU limit will cause this error to be shown to the end-users. Then, they can choose to bring down some workloads in the AWS cloud to free up space. The next time a VM creation task is attempted, it will succeed, and the condition will be marked as a success.

Expand Down Expand Up @@ -173,11 +173,11 @@ Palette will perform a rolling upgrade on the nodes for any fundamental changes

Palette keeps track of the reason that triggered the rolling upgrade on the nodes in the cluster and is made accessible under **Cluster Overview** > **Upgrade details**.

![upgrade-details1.png](upgrade-details1.png)
![upgrade-details1.png](/upgrade-details1.png)

Besides actions taken by the user, Palette also performs a rolling upgrade if the cluster nodes' health degrades. Palette keeps track of the nodes machine's health and will relaunch the node when the machine health check fails.

![upgrade-details2.png](upgrade-details2.png)
![upgrade-details2.png](/upgrade-details2.png)

The following are some sample scenarios where the node health is considered as degraded:

Expand Down

0 comments on commit df43ace

Please sign in to comment.