Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add spacetastic story to AWS Getting Started DOC-1332 #4019

Merged
merged 23 commits into from
Sep 23, 2024
Merged
Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
ea76421
docs: add spacetastic story DOC-1332
addetz Sep 19, 2024
d5ac761
docs: adjust conversation punctuation DOC-1332
addetz Sep 19, 2024
7d53e0e
docs: remove gendered language DOC-1332
addetz Sep 19, 2024
326beae
docs: remove repeated spacetastic
addetz Sep 19, 2024
3365f9c
Optimised images with calibre/image-actions
vault-token-factory-spectrocloud[bot] Sep 19, 2024
29dea0f
Optimised images with calibre/image-actions
vault-token-factory-spectrocloud[bot] Sep 19, 2024
f308240
docs: fix formatting
addetz Sep 19, 2024
3c2a8db
docs: adjust systems diagram
addetz Sep 20, 2024
cd7e0bd
Optimised images with calibre/image-actions
vault-token-factory-spectrocloud[bot] Sep 20, 2024
ad54ded
docs: add story to setup page DOC-1332
addetz Sep 20, 2024
843fc8c
Optimised images with calibre/image-actions
vault-token-factory-spectrocloud[bot] Sep 20, 2024
e84fe3a
docs: add story to create cluster profile page DOC-1332
addetz Sep 20, 2024
13a0fd8
docs: add spacetastic story to rest of getting started DOC-1332
addetz Sep 23, 2024
7a4481c
Optimised images with calibre/image-actions
vault-token-factory-spectrocloud[bot] Sep 23, 2024
79ace2b
docs: fix vale
addetz Sep 23, 2024
e6f0943
docs: fix vale
addetz Sep 23, 2024
553362f
docs: fix vale
addetz Sep 23, 2024
7b15fdf
Apply suggestions from code review
addetz Sep 23, 2024
eea472d
Update docs/docs-content/getting-started/aws/scale-secure-cluster.md
addetz Sep 23, 2024
b3b5309
docs: fix formatting
addetz Sep 23, 2024
f7a508f
docs: add call reference to additional capabilities on scale secure D…
addetz Sep 23, 2024
39b04db
docs: fix vale
addetz Sep 23, 2024
7f65a70
Optimised images with calibre/image-actions
vault-token-factory-spectrocloud[bot] Sep 23, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 46 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,52 @@ 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.

## Case Study

Spacetastic Ltd., our fictional example company, is on a mission to teach its users about space. They have assembled a
addetz marked this conversation as resolved.
Show resolved Hide resolved
team of phycists and engineers who are passionate about astronomy and the universe. They are a start up 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
addetz marked this conversation as resolved.
Show resolved Hide resolved
> 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
addetz marked this conversation as resolved.
Show resolved Hide resolved
addetz marked this conversation as resolved.
Show resolved Hide resolved
> 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
addetz marked this conversation as resolved.
Show resolved Hide resolved
addetz marked this conversation as resolved.
Show resolved Hide resolved
addetz marked this conversation as resolved.
Show resolved Hide resolved
> platform. I make sure that all 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)
addetz marked this conversation as resolved.
Show resolved Hide resolved

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
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)
addetz marked this conversation as resolved.
Show resolved Hide resolved
addetz marked this conversation as resolved.
Show resolved Hide resolved

While the system architecture they have chosen was a great place to start, the team soon face common challenges that
many growing organisations encounter with Kubernetes.
addetz marked this conversation as resolved.
Show resolved Hide resolved

> Wren hurriedly walks into the office, looking at their phone with a worried expression. "Users are reporting that our
> systems are down on social media! This must be related to the new feature we have just released."
addetz marked this conversation as resolved.
Show resolved Hide resolved
>
> Meera looks up from their monitor. "I've also received an alert about a new zero-day vulnerability. We need to patch
addetz marked this conversation as resolved.
Show resolved Hide resolved
addetz marked this conversation as resolved.
Show resolved Hide resolved
> 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
addetz marked this conversation as resolved.
Show resolved Hide resolved
> confidence, ultimately supporting the growth of our company." says Kai with a determined look.
addetz marked this conversation as resolved.
Show resolved Hide resolved

![Kubernetes challenges](/getting-started/getting-started_landing_kubernetes-challenges.webp)

## Get Started

Expand Down
32 changes: 31 additions & 1 deletion docs/docs-content/getting-started/aws/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,28 @@ tags: ["getting-started", "aws"]
---

In this guide, you will learn how to set up Palette for use with your AWS cloud account. These steps are required in
order to authenticate Palette and allow it to deploy host clusters.
order to authenticate Palette and allow it to deploy host clusters. The concepts you learn about in the Getting Started
section are centered around a fictional case study company, Spacetastic Ltd.
addetz marked this conversation as resolved.
Show resolved Hide resolved

The Spacetastic team decide to look for an external solution that can help them scale and manage their Kubernetes
addetz marked this conversation as resolved.
Show resolved Hide resolved
services. Partnering with a team of Kubernetes experts allows them to focus on expanding their astronomy education
platform, instead of spending countless hours migrating and rehosting their services. They identify the following list
addetz marked this conversation as resolved.
Show resolved Hide resolved
of features that their new platform should provide.

- Simplified Kubernetes cluster deployment process across cloud providers.
- Cluster maintenance and security patching across environments.
- Monitoring and observability of Kubernetes workloads.

> "I have so many ideas for new features for our backlog." says Anya, Lead Astrophycist. "Our community of space
addetz marked this conversation as resolved.
Show resolved Hide resolved
> explorers want to keep learning, so we shouldn't slow down our implementation cycle."
>
> Kai nods knowingly. As a Platform Engineer, they agree with Anya's concerns. "I've done some research on Kubernetes
addetz marked this conversation as resolved.
Show resolved Hide resolved
addetz marked this conversation as resolved.
Show resolved Hide resolved
> orchestration solutions. It seems that Palette has all the capabilities we need to help us grow."
>
> "I agree with both of you, but I want to review the developer experience in detail before we agree to implement a new
> solution in production." says Wren, whose main concern as Founding Engineer is to ensure developer velocity does not
> decrease. "Let's reach out to Spectro Cloud to create an account. Then, we can make an informed decision after we
> complete their Getting Started tutorials."

## Prerequisites

Expand Down Expand Up @@ -55,3 +76,12 @@ You can verify your account is added.
Now that you set up Palette for use with AWS, you can start deploying Kubernetes clusters to your AWS account. To learn
how to get started with deploying Kubernetes clusters to AWS, we recommend that you continue to the
[Create a Cluster Profile](./create-cluster-profile.md) tutorial to create a full cluster profile for your host cluster.

After following the detailed Palette setup instructions, the Spacetastic team have added their cloud accounts on the
addetz marked this conversation as resolved.
Show resolved Hide resolved
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
> 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_
addetz marked this conversation as resolved.
Show resolved Hide resolved
> solutions. Let's review their Getting Started material together to ensure that it's a good fit for us."
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading