Skip to content

Commit

Permalink
docs: DOC-1518: Getting Started cleanup (#5042)
Browse files Browse the repository at this point in the history
* Initial Getting Started cleanup

* Updates to Deploy Cluster Profile page

* Minor parallel fix and package.json output update for deploy custom add-on pack tutorial

* Updates to scale cluster section

* Copying certain AWS changes over to other provider tutorials

* Updated filter image for Azure clusters

* ci: auto-formatting prettier issues

* Optimised images with calibre/image-actions

* Fixed ableism with see

* ci: auto-formatting prettier issues

---------

Co-authored-by: achuribooks <[email protected]>
Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
  • Loading branch information
3 people authored and lennessyy committed Dec 20, 2024
1 parent 21aa235 commit d7c483a
Show file tree
Hide file tree
Showing 33 changed files with 208 additions and 234 deletions.
2 changes: 1 addition & 1 deletion _partials/getting-started/_cluster_observability.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ partial_category: getting-started
partial_name: cluster-observability
---

As we have seen throughout this tutorial, Palette exposes a set of workload metrics out-of-the-box to help cluster
As we have seen throughout this tutorial, Palette exposes a set of workload metrics out of the box to help cluster
administrators better understand the resource utilization of the cluster. The <VersionedLink text="workload metrics" url="/clusters/cluster-management/workloads/" /> in Palette are a snapshot in
time and do not provide alerting capabilities.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ partial_name: spacetastic-create-cluster-profile-end
Wren and Kai have created their first Palette cluster profile by following the steps described in this guide. They are
in good spirits, as the process has gone smoothly.

> "The visual representation of cluster profiles in Palette is much clearer than our whiteboard." says Kai, glancing
> "The visual representation of cluster profiles in Palette is much clearer than our whiteboard," says Kai, glancing
> back at the list they have created. "I can keep track of which versions we are using in production just by reviewing
> the profile. What are your thoughts, Wren? Have you remained a Palette skeptic?"
>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ begin to map out all the dependencies of their systems and infrastructure.
> making a lot of design decisions myself, as I was Spacetastic's Founding Engineer. It's really interesting to look
> back on how much we've built and grown since those days!"
>
> Kai smiles and nods. "It's definitely been an out of this world ride!" they say. "I have a similar feeling when I
> Kai smiles and nods. "It's definitely been an out-of-this-world ride!" they say. "I have a similar feeling when I
> think about the infrastructure that I built in the early days as Platform Engineer. I will add our infrastructure
> layers to your list. This process has the added bonus of giving us a chance to review which dependencies need to be
> updated, so Meera, our security expert, will be happy too."
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ partial_name: spacetastic-deploy-cluster-tf-end
---

Wren and Kai have followed this tutorial and have learned how Palette supports IaC through Terraform. They found the
essentials covered to be a great introduction to IaC and gives them the confidence to kick off this initiative at
essentials covered to be a great introduction to IaC, and it gives them the confidence to kick off this initiative at
Spacetastic.

> "I'd say that deploying Palette clusters with Terraform is even more convenient than through the UI." says Kai. "The
> "I'd say that deploying Palette clusters with Terraform is even more convenient than through the UI," says Kai. "The
> Palette Terraform provider includes a lot of the same functionality that the UI provides."
>
> "Yes! I definitely agree. I'm a Terraform novice and I could follow along with this tutorial." says Wren. "This has
> "Yes! I definitely agree. I'm a Terraform novice and I could follow along with this tutorial," says Wren. "This has
> definitely inspired me to make our IaC adoption a priority in the medium term future."
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ partial_name: spacetastic-deploy-cluster-tf-intro
---

After following the tutorials in the Getting Started section, the Spacetastic team have been have been impressed with
its capabilities. Wren, Founding Engineer, and Kai, Platform Engineer, have been discussing adopting IaC workflows and
Palette's capabilities. Wren, Founding Engineer, and Kai, Platform Engineer, have been discussing adopting IaC workflows and
have been upskilling with Terraform throughout the past year. They are interested in learning if Palette can support IaC
workflows too.

> "While we're on the topic of platform improvements, it would be great to kick off our adoption of Infrastructure as
> Code at Spacetastic." says Wren. "I've been wanting to roll this out for a while, but we don't have that much in-house
> Code at Spacetastic," says Wren. "I've been wanting to roll this out for a while, but we don't have that much in-house
> expertise."
>
> "Yes, this would definitely be a big improvement to our processes." says Kai, Platform Engineer. "Some people might
> "Yes, this would definitely be a big improvement to our processes," says Kai, Platform Engineer. "Some people might
> think that it slows down the development and release processes, due to the extra code reviews. However, the ability to
> revert in the case of an outage more than makes up for this small drop in velocity."
>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,17 @@ partial_name: spacetastic-deploy-cluster-end
Wren and Kai have deployed their first cluster profile by following the steps described in this tutorial. They were
impressed by how streamlined the process was and how the cluster profiles provided them with a deployment blueprint.

> "Deploying our first cluster with Palette was intuitive." says Wren. "It's ideal to find an external partner that can
> "Deploying our first cluster with Palette was intuitive," says Wren. "It's ideal to find an external partner that can
> take care of our Kubernetes infrastructure and free us up to deliver more educational features. I definitely think
> that Palette has the capabilities to take care of all the Kubernetes heavy lifting for us."
>
> "I agree with you and I'm glad to hear you're not as skeptical anymore." says Kai, nodding and laughing. "From a
> "I agree with you, and I'm glad to hear you're not as skeptical anymore," says Kai, nodding and laughing. "From a
> platform engineering perspective, I can say that cluster profiles will provide us with reliable deployments across
> environments and even clouds, so I'm much more confident about our testing and deployment strategy."
>
> Meera, Head of Cybersecurity, walks in holding a file. "I've done our security due diligence and I'm happy to report
> Meera, Head of Cybersecurity, walks in holding a file. "I've done our security due diligence, and I'm happy to report
> that Spectro Cloud adheres to the highest security standards. I'm happy to approve Palette for use in our
> organization."
>
> "It seems like we've found a great platform that can support us. Let's explore the rest of the Getting Started section
> to understand what else Palette has to offer." says Kai turning back to their monitor.
> to understand what else Palette has to offer," says Kai, turning back to their monitor.
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ partial_name: spacetastic-deploy-cluster-intro
---

After successfully creating their first cluster profile and mapping out their entire technology stack, Wren, Founding
Engineer and Kai, Platform Engineer, continue their Palette onboarding process. They are evaluating Palette as a
potential platform orchestration tool for all the production workloads at Spacetastic, who provide an astronomy
Engineer, and Kai, Platform Engineer, continue their Palette onboarding process. They are evaluating Palette as a
potential platform orchestration tool for all the production workloads at Spacetastic, which provides an astronomy
education platform deployed on Kubernetes.

> "The Getting Started section is a great way to learn about Palette. The hands-on approach is just what we need to get
> our first cluster deployed." says Kai, scrolling through the Spectro Cloud Docs. "Wren, do you have time to continue
> our first cluster deployed," says Kai, scrolling through the Spectro Cloud Docs. "Wren, do you have time to continue
> our onboarding and get our first cluster deployed?"
>
> Wren sits down next to Kai and sips on a cup of coffee. "Now, we'll get a hands-on feel of the Palette developer
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,19 @@ partial_name: spacetastic-landing-intro
---

Spacetastic Ltd., our fictional example company, is on a mission to teach its users about space. They have assembled a
team of bright minds who are passionate about astronomy and the universe. They are a startup that is gaining popularity,
team of bright minds who are passionate about astronomy and the universe. They are a startup that is gaining popularity
as they expand their dashboards and grow their subscribers. Their small team has been in charge of developing new
features alongside scaling and maintaining their infrastructure, but they are dedicated to providing the best astronomy
education platform on Planet Earth.

> "I'm the resident space expert around here!" says Anya, Lead Astrophycist, with a beaming smile. "My mission is to
> make astrophysics, the science of space, accessible to everyone."
>
> "I'm here to support you and your mission. I build all the dashboards, pages and features that bring your vast space
> "I'm here to support you and your mission. I build all the dashboards, pages, and features that bring your vast space
> knowledge to our users in a beautiful visual format!" says Wren, Founding Engineer.
>
> Kai smiles and nods. "I work closely with both Wren and Anya. As Platform Engineer, I ensure that our platform is
> reliable and scalable for everyone around the world, and beyond!"
> reliable and scalable for everyone around the world and beyond!"
>
> Meera, Head of Cybersecurity, is the final member of the Spacetastic team. "Let's not forget about the security of our
> platform. I make sure that our systems are designed and implemented with security in mind, the true SecDevOps way."
Expand All @@ -29,7 +29,7 @@ reliability SLA of at least 99% uptime. The following diagram presents an overvi

![Spacetastic system diagram](/getting-started/getting-started_landing_spacetastic-systems.webp)

While the system architecture they have chosen was a great place to start, the team soon face common challenges that
While the system architecture they have chosen was a great place to start, the team soon faced common challenges that
many growing organizations encounter with Kubernetes.

> Wren hurriedly walks into the office, looking at their phone with a worried expression. "Users are reporting on social
Expand All @@ -39,6 +39,6 @@ many growing organizations encounter with Kubernetes.
> our services without further downtime, as soon as you are able to stabilize our platform."
>
> "Team, we need to rethink our platform engineering tools. We need a solution that can help us scale and deploy with
> confidence, ultimately supporting the growth of our company." says Kai with a determined look.
> confidence, ultimately supporting the growth of our company," says Kai with a determined look.
![Kubernetes challenges](/getting-started/getting-started_landing_kubernetes-challenges.webp)
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,16 @@ After going through the steps in the tutorial, Kai is confident in Palette's upg
> "What have you found out, Kai?" says Meera walking over to Kai's desk. "Can I rely on Palette when a zero-day
> vulnerability comes in?"
>
> "Yes, I know how stressful it is when those are reported." says Kai with a sympathetic nod. "I found out that Palette
> "Yes, I know how stressful it is when those are reported," says Kai with a sympathetic nod. "I found out that Palette
> has our security covered through their pack updates and scanning capabilities. Relying on this kind of tooling is
> invaluable to security conscious engineers like us."
> invaluable to security-conscious engineers like us."
>
> "Excellent! These capabilities will be a great addition to our existing systems at Spacetastic." says Meera with a big
> "Excellent! These capabilities will be a great addition to our existing systems at Spacetastic," says Meera with a big
> grin.
>
> "I'm so glad that we found a platform that can support everyone!" says Kai. "There is so much more to explore though.
> I will keep reading through the Getting Started section and find out what additional capabilities Palette provides."
>
> "Good thinking, Kai." says Meera, nodding. "We should maximize all of Palette's features now that we have implemented
> "Good thinking, Kai," says Meera, nodding. "We should maximize all of Palette's features now that we have implemented
> it in production. We've got big ideas and goals on our company roadmap, so let's find out how Palette can help us
> deliver them."
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ platform matures. They must ensure that their systems are patched, upgraded, sca
These maintenance tasks must be automated and applied on a schedule, as the entire team wants to focus on providing
Spacetastic features.

> "I've read your report on Palette adoption at Spacetastic." says Meera, who provides the security expertise at
> Spacetastic. I was impressed with the ability to roll out updates to all clusters using the same cluster profile. This
> "I've read your report on Palette adoption at Spacetastic," says Meera, who provides the security expertise at
> Spacetastic. "I was impressed with the ability to roll out updates to all clusters using the same cluster profile. This
> will streamline our system upgrades and cluster patching. Keeping up with security best practices has never been more
> important, now that we are growing faster than ever!"
>
> "I agree. No matter how safe our coding practices are, we need to periodically review, patch and upgrade our
> dependencies." says Wren, who leads the engineering team at Spacetastic.
> "I agree. No matter how safe our coding practices are, we need to periodically review, patch, and upgrade our
> dependencies," says Wren, who leads the engineering team at Spacetastic.
>
> Kai nods, scrolling through the Palette Docs. "Team, Palette has more security and Day-2 operation support than we
> have explored so far. I will continue their Getting Started section and report back with my findings."
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ partial_name: spacetastic-setup-end
After following the detailed Palette setup instructions, the Spacetastic team have added their cloud accounts on the
Palette dashboard. They are ready to learn about Palette.

> "The Spectro Cloud team has provided our Palette accounts" says Kai. "I have followed their setup guide and have added
> "The Spectro Cloud team has provided our Palette accounts," says Kai. "I have followed their setup guide and have added
> our cloud accounts. I can already tell at a first glance that they offer many Kubernetes customization features."
>
> Wren joins Kai in looking at the Palette dashboard. "I'm interested to learn more, but I never believe in _magic_
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ partial_name: spacetastic-update-cluster-end
Wren and Kai have followed this tutorial and now have a great understanding of what cluster profile updates mean to
deployed clusters. They are impressed with Palette's cluster management capabilities.

> "Neat! Palette's cluster profiles allow us to review all updates we apply to our clusters." says Kai. "I can finally
> "Neat! Palette's cluster profiles allow us to review all updates we apply to our clusters," says Kai. "I can finally
> take my vacation days, once we can safely maintain our clusters."
>
> "Don't I know the feeling?" laughs Wren. "I think we could all use more vacations, quiet weekends and less excitement
> "Don't I know the feeling?" laughs Wren. "I think we could all use more vacations, quiet weekends, and less excitement
> when it comes to the Spacetastic platform."
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ of the Spacetastic platform and infrastructure. The team have identified the fol

> Wren, Founding Engineer, and Kai, Platform Engineer, have been learning and experimenting with Palette.
>
> "The streamlined deployment process is just one part of the improvements we've got planned for our platform." says
> "The streamlined deployment process is just one part of the improvements we've got planned for our platform," says
> Kai. "I'm interested to learn how Palette's cluster profiles behave when applying updates and other changes to our
> clusters."
>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ tags: ["getting-started", "aws"]

Palette offers profile-based management for Kubernetes, enabling consistency, repeatability, and operational efficiency
across multiple clusters. A cluster profile allows you to customize the cluster infrastructure stack, allowing you to
choose the desired Operating System (OS), Kubernetes, Container Network Interfaces (CNI), Container Storage Interfaces
(CSI). You can further customize the stack with add-on application layers. For more information about cluster profile
types, refer to [Cluster Profiles](../introduction.md#cluster-profiles).
choose the desired Operating System (OS), Kubernetes, Container Network Interfaces (CNIs), and Container Storage
Interfaces (CSIs). You can further customize the stack with add-on application layers. For more information about
cluster profile types, refer to [Cluster Profiles](../introduction.md#cluster-profiles).

In this tutorial, you create a full profile directly from the Palette dashboard. Then, you add a layer to your cluster
profile by using a [community pack](../../integrations/community_packs.md) to deploy a web application. The concepts you
Expand Down Expand Up @@ -104,8 +104,6 @@ preset. Replace these values with your own base64 encoded values. The
[_hello-universe_](https://github.com/spectrocloud/hello-universe?tab=readme-ov-file#single-load-balancer) repository
provides an unencoded token that you can use.

Click on **Confirm Updates**. The manifest editor closes.

Click on **Confirm & Create** to save the manifest. Then, click on **Save Changes** to save this new layer to the
cluster profile.

Expand Down
9 changes: 5 additions & 4 deletions docs/docs-content/getting-started/aws/deploy-k8s-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,8 @@ To complete this tutorial, you will need the following.

The following steps will guide you through deploying the cluster infrastructure.

Navigate to the left **Main Menu** and select **Clusters**. Click on **Create Cluster**.
Navigate to the left **Main Menu** and select **Clusters**. Click on **Create Cluster**. If there are existing clusters,
choose **Add New Cluster**.

![Palette clusters overview page](/getting-started/getting-started_deploy-k8s-cluster_new_cluster.webp)

Expand Down Expand Up @@ -106,9 +107,9 @@ Navigate to the left **Main Menu** and select **Clusters**.

![Update the cluster](/getting-started/aws/getting-started_deploy-k8s-cluster_create_cluster.webp)

The cluster deployment process can take 15 to 30 min. The deployment time varies depending on the cloud provider,
cluster profile, cluster size, and the node pool configurations provided. You can learn more about the deployment
progress by reviewing the event log. Click on the **Events** tab to view the log.
The cluster deployment process can take 15 to 30 minutes. Deployment time varies depending on the cloud provider,
cluster profile, cluster size, and node pool configurations provided. You can learn more about the deployment progress
by reviewing the event log. Choose your cluster and select the **Events** tab to view the log.

![Update the cluster](/getting-started/aws/getting-started_deploy-k8s-cluster_event_log.webp)

Expand Down
Loading

0 comments on commit d7c483a

Please sign in to comment.