Skip to content

Commit

Permalink
docs: add spacetastic story to AWS Getting Started DOC-1332 (#4019)
Browse files Browse the repository at this point in the history
* docs: add spacetastic story DOC-1332

* docs: adjust conversation punctuation DOC-1332

* docs: remove gendered language DOC-1332

* docs: remove repeated spacetastic

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* docs: fix formatting

* docs: adjust systems diagram

* Optimised images with calibre/image-actions

* docs: add story to setup page DOC-1332

* Optimised images with calibre/image-actions

* docs: add story to create cluster profile page DOC-1332

* docs: add spacetastic story to rest of getting started DOC-1332

* Optimised images with calibre/image-actions

* docs: fix vale

* docs: fix vale

* docs: fix vale

* Apply suggestions from code review

Co-authored-by: caroldelwing <[email protected]>
Co-authored-by: Karl Cardenas <[email protected]>

* Update docs/docs-content/getting-started/aws/scale-secure-cluster.md

Co-authored-by: Karl Cardenas <[email protected]>

* docs: fix formatting

* docs: add call reference to additional capabilities on scale secure DOC-1332

* docs: fix vale

* Optimised images with calibre/image-actions

---------

Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
Co-authored-by: caroldelwing <[email protected]>
Co-authored-by: Karl Cardenas <[email protected]>
  • Loading branch information
4 people authored Sep 23, 2024
1 parent a28d690 commit 4d9e464
Show file tree
Hide file tree
Showing 11 changed files with 281 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,35 @@ This section introduces you to some of Palette's additional capabilities, which

![A drawing of Palette with humans interacting](/getting-started/getting-started_additional-capabilities_palette.webp)

The concepts you learn about in the Getting Started section are centered around a fictional case study company,
Spacetastic Ltd.

## πŸ§‘β€πŸš€ Back at Spacetastic HQ

Spacetastic has been a Palette customer for a few months. In this time, they have become the leading astronomy education
platform. They want to keep pushing the limits of their platform and implement some innovative capabilities. To support
this growth, they will need to expand their team, infrastructure, and systems. They continue exploring the Getting
Started section to learn how they can grow with Palette and have a long-term relationship with Spectro Cloud.

> "Wouldn’t bringing some astronomy into everyone's home be great?" says Anya, Lead Astrophycist, who has always the
> dreamer of the team. "I wonder how we could make that possible."
>
> Kai is in charge of scaling the Spacetastic platform. "That would be a great dream and a challenge for us, Anya." they
> say.
>
> "You know, we might be able to make your dream happen!" says Wren, Founding Engineer. "Palette's edge capabilities
> could make it possible for us to bring Spacetastic to many devices."
>
> "I can't believe my ears!" says Kai laughing. "Wren, our resident Palette sceptic, has well and truly embraced our new
> platform solution."
>
> Wren laughs and quickly responds. "Oh and one more thing! Palette doesn't lock us into a single tech stack or cloud
> provider, so we can deploy our services in many locations."
>
> "Palette makes Kubernetes just as secure on edge devices as it is in large data centers." says Meera, Head of
> Cybersecurity, joining in. "We'll make your dream a reality and bring Spacetastic to everyone soon enough, Anya. The
> sky's the limit for us!"
## The Journey Continues

In this section, you get an overview of other parts of Palette not yet covered by your Getting Started journey so far.
Expand Down
46 changes: 45 additions & 1 deletion docs/docs-content/getting-started/aws/aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,51 @@ tags: ["getting-started", "aws"]
---

Palette supports integration with [Amazon Web Services](https://aws.amazon.com). You can deploy and manage
[Host Clusters](../../glossary-all.md#host-cluster) in AWS.
[Host Clusters](../../glossary-all.md#host-cluster) in AWS. The concepts you learn about in the Getting Started section
are centered around a fictional case study company. This approach gives you a solution focused approach, while
introducing you with Palette workflows and capabilities.

## πŸ§‘β€πŸš€ Welcome to Spacetastic!

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,
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
> 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!"
>
> 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."
![Meet the Spacetastic team](/getting-started/getting-started_landing_meet-the-team.webp)

The team has deployed their services to a single cloud provider. They rely on Kubernetes for the reliability and
scalability of their systems. The team must ensure the systems are secure, patched regularly, scalable, and meet a
reliability SLA of at least 99% uptime. The following diagram presents an overview of their systems.

![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
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
> media that our systems are down! This must be related to the new feature we have just released."
>
> Meera looks up from their monitor. "I've also received an alert about a new zero-day vulnerability. We need to patch
> 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.
![Kubernetes challenges](/getting-started/getting-started_landing_kubernetes-challenges.webp)

## Get Started

Expand Down
29 changes: 28 additions & 1 deletion docs/docs-content/getting-started/aws/create-cluster-profile.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,22 @@ choose the desired Operating System (OS), Kubernetes, Container Network Interfac
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.
profile by using a [community pack](../../integrations/community_packs.md) to deploy a web application. The concepts you
learn about in the Getting Started section are centered around a fictional case study company, Spacetastic Ltd.

## πŸ§‘β€πŸš€ Back at Spacetastic HQ

The team are busy exploring and evaluating Palette. In order to prepare for a migration to any external platform, they
begin to map out all the dependencies of their systems and infrastructure.

> Wren begins creating the list. "Our tech stack has grown, as we have added features and capabilities. I remember
> 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
> 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."
## Prerequisites

Expand Down Expand Up @@ -111,3 +126,15 @@ In this tutorial, you created a cluster profile, which is a template that contai
host cluster using Amazon Web Services (AWS). You added a community pack to your profile to deploy a custom workload. We
recommend that you continue to the [Deploy a Cluster](./deploy-k8s-cluster.md) tutorial to deploy this cluster profile
to a host cluster onto AWS.

## πŸ§‘β€πŸš€ Catch up with Spacetastic

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
> 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 sceptic?"
>
> Wren laughs. "Yes, I admit cluster profiles are very convenient. I'm not convinced yet, but I am already starting to
> understand how Palette could make us more productive. Let's keep exploring and get something deployed with it!"
37 changes: 37 additions & 0 deletions docs/docs-content/getting-started/aws/deploy-k8s-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,26 @@ Kubernetes with minimal effort.
As you navigate the tutorial, refer to this diagram to help you understand how Palette uses a cluster profile as a
blueprint for the host cluster you deploy. Palette clusters have the same node pools you may be familiar with: _control
plane nodes_ and _worker nodes_ where you will deploy applications. The result is a host cluster that Palette manages.
The concepts you learn about in the Getting Started section are centered around a fictional case study company,
Spacetastic Ltd.

![A view of Palette managing the Kubernetes lifecycle](/getting-started/getting-started_deploy-k8s-cluster_application.webp)

## πŸ§‘β€πŸš€ Back at Spacetastic HQ

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
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 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
> experience. You know me, I'm a champion for developer tooling and always supportive of investing in our platform.
> Let’s follow this tutorial and deploy a cluster using the Palette UI."
## Prerequisites

To complete this tutorial, you will need the following.
Expand Down Expand Up @@ -173,3 +190,23 @@ deployed, you verified the Hello Universe application was successfully deployed.

We recommend that you continue to the [Deploy Cluster Profile Updates](./update-k8s-cluster.md) tutorial to learn how to
update your host cluster.

## πŸ§‘β€πŸš€ Catch up with Spacetastic

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
> 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 sceptical 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
> 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.
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,26 @@ provisioning of resources, collaborate on changes, and maintain a single source

This tutorial will teach you how to use Terraform to deploy and update an Amazon Web Services (AWS) host cluster. You
will learn how to create two versions of a cluster profile with different demo applications, update the deployed cluster
with the new cluster profile version, and then perform a rollback.
with the new cluster profile version, and then perform a rollback. The concepts you learn about in the Getting Started
section are centered around a fictional case study company, Spacetastic Ltd.

## πŸ§‘β€πŸš€ Back at Spacetastic HQ

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
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
> expertise."
>
> "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."
>
> Wren nods, knowingly. "Let's explore Palette's IaC capabilities and maybe we can apply some learnings to our
> infrastructure."
## Prerequisites

Expand Down Expand Up @@ -741,3 +760,15 @@ cluster profile roll backs.

We encourage you to check out the [Scale, Upgrade, and Secure Clusters](./scale-secure-cluster.md) tutorial to learn how
to perform common Day-2 operations on your deployed clusters.

## πŸ§‘β€πŸš€ Catch up with Spacetastic

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
Spacetastic.

> "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
> definitely inspired me to make our IaC adoption a priority in the medium term future."
43 changes: 42 additions & 1 deletion docs/docs-content/getting-started/aws/scale-secure-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,27 @@ scans.

This tutorial will teach you how to use the Palette UI to perform scale and maintenance tasks on your clusters. You will
learn how to create Palette projects and teams, import a cluster profile, safely upgrade the Kubernetes version of a
deployed cluster and scale up your cluster nodes.
deployed cluster and scale up your cluster nodes. The concepts you learn about in the Getting Started section are
centered around a fictional case study company, Spacetastic Ltd.

## πŸ§‘β€πŸš€ Back at Spacetastic HQ

The team have been impressed with Palette's capabilities and decide to become a Spectro Cloud customer. The last piece
of the puzzle is to learn how to handle Day-2 operations, which become increasingly more important as the Spacetastic
platform matures. They must ensure that their systems are patched, upgraded, scaled, and scanned for vulnerabilities.
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
> 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.
>
> 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."
## Prerequisites

Expand Down Expand Up @@ -514,3 +534,24 @@ them.

We encourage you to check out the [Additional Capabilities](../additional-capabilities/additional-capabilities.md) to
explore other Palette functionalities.

## πŸ§‘β€πŸš€ Catch up with Spacetastic

After going through the steps in the tutorial, Kai is confident in Palette's upgrade and scanning capabilities.

> "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
> 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."
>
> "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
> 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."
Loading

0 comments on commit 4d9e464

Please sign in to comment.