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: PEM-6808: Adding AWS Secret Cloud documentation #5624

Merged
merged 13 commits into from
Feb 3, 2025

Conversation

achuribooks
Copy link
Contributor

@achuribooks achuribooks commented Feb 3, 2025

Describe the Change

This PR adds a section on the Add AWS Account to Palette page for configuring a AWS Secret Cloud accounts with VerteX.

NOTE: We are not advertising that AWS IaaS clusters or Top Secret (CAP) credentials are supported at this time. These will need to be added in the future at the discretion of Sumit and Robert.

Changed Pages

💻
Add an AWS Account to Palette - New section on AWS Secret
Create and Manage AWS EKS Cluster - Added ImageSwap prereq as well as static placement and cluster endpoint access requirements
Getting Started - AWS Prereqs - Adjusted due to updated partial

Jira Tickets

🎫 PEM-6808

Backports

Can this PR be backported?

  • Yes. Remember to add the relevant backport labels to your PR.
  • No. Please leave a short comment below about why this PR cannot be backported.

4.6 release work.

@achuribooks achuribooks changed the title Adding AWS Secret Cloud documentation docs: PEM-6808: Adding AWS Secret Cloud documentation Feb 3, 2025
@achuribooks achuribooks added the 4.6 label Feb 3, 2025
@achuribooks achuribooks marked this pull request as ready for review February 3, 2025 13:52
@achuribooks achuribooks requested a review from a team as a code owner February 3, 2025 13:52
Copy link
Contributor

github-actions bot commented Feb 3, 2025

🤖 Netlify configured to enable preview build for branch: PEM-6808 . Subsequent commits will automatically trigger a Netlify build preview.

Copy link

netlify bot commented Feb 3, 2025

Deploy Preview for docs-spectrocloud ready!

Name Link
🔨 Latest commit 3b08b9f
🔍 Latest deploy log https://app.netlify.com/sites/docs-spectrocloud/deploys/67a12cd93aa9af0008b80be8
😎 Deploy Preview https://deploy-preview-5624--docs-spectrocloud.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

@caroldelwing caroldelwing left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work, Amanda :) I left you a few questions/suggestions.

docs/docs-content/getting-started/aws/setup.md Outdated Show resolved Hide resolved
_partials/_aws-static-credentials-setup.mdx Outdated Show resolved Hide resolved
Copy link
Contributor

@caroldelwing caroldelwing left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved with two tiny suggestions :)

@achuribooks achuribooks merged commit a97378a into release-4-6 Feb 3, 2025
10 checks passed
@achuribooks achuribooks deleted the PEM-6808 branch February 3, 2025 21:18
addetz pushed a commit that referenced this pull request Feb 5, 2025
* Adding AWS Secret Cloud documentation

* ci: auto-formatting prettier issues

* Fixing spacing

* ci: auto-formatting prettier issues

* Adjusting Getting Started AWS prereqs to account for updated partial

* ci: auto-formatting prettier issues

* Incorporating suggestions from Carolina

* ci: auto-formatting prettier issues

* Incorporating feedback from Carolina

* ci: auto-formatting prettier issues

* Apply suggestions from code review

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

* ci: auto-formatting prettier issues

---------

Co-authored-by: achuribooks <[email protected]>
Co-authored-by: caroldelwing <[email protected]>
addetz pushed a commit that referenced this pull request Feb 7, 2025
* Adding AWS Secret Cloud documentation

* ci: auto-formatting prettier issues

* Fixing spacing

* ci: auto-formatting prettier issues

* Adjusting Getting Started AWS prereqs to account for updated partial

* ci: auto-formatting prettier issues

* Incorporating suggestions from Carolina

* ci: auto-formatting prettier issues

* Incorporating feedback from Carolina

* ci: auto-formatting prettier issues

* Apply suggestions from code review

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

* ci: auto-formatting prettier issues

---------

Co-authored-by: achuribooks <[email protected]>
Co-authored-by: caroldelwing <[email protected]>
achuribooks added a commit that referenced this pull request Feb 7, 2025
achuribooks added a commit that referenced this pull request Feb 10, 2025
caroldelwing added a commit that referenced this pull request Feb 16, 2025
* feat: release 4.6

* docs: PCP-4049: MicroK8s 1.28 > 1.29 Known Issue for MAAS and AWS Clusters (#5568)

* Adding MicroK8s 1.28 > 1.29 known issue for MAAS and AWS clusters

* Empty commit for Netlify preview

* Small verbiage adjustments; adding command to restart Cilium pods

* ci: auto-formatting prettier issues

* Update docs/docs-content/release-notes/known-issues.md

Incorporating "version" suggestion from Karl.

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

* ci: auto-formatting prettier issues

---------

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

* docs: DOC-1646: Update API Rate Limit for v1/cloudconfig Resources (#5609)

* Updating API rate limit for v1/cloudconfigs resources; adding to 4.6 release notes as improvement

* Changing link from relative to direct URL

* ci: auto-formatting prettier issues

---------

Co-authored-by: achuribooks <[email protected]>

* docs: PEM-6808: Adding AWS Secret Cloud documentation (#5624)

* Adding AWS Secret Cloud documentation

* ci: auto-formatting prettier issues

* Fixing spacing

* ci: auto-formatting prettier issues

* Adjusting Getting Started AWS prereqs to account for updated partial

* ci: auto-formatting prettier issues

* Incorporating suggestions from Carolina

* ci: auto-formatting prettier issues

* Incorporating feedback from Carolina

* ci: auto-formatting prettier issues

* Apply suggestions from code review

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

* ci: auto-formatting prettier issues

---------

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

* docs: add cluster removal expired cloud credentials known issue PEM-6961 (#5702)

* Palette 4.6.0 API docs (#5701)

* Palette 4.6.0 API docs

* ci: auto-formatting API changes

---------

Co-authored-by: addetz <[email protected]>

* docs: DOC-1616: Whitelabels (#5694)

* Initial commit for whitelabel feature

* Minor adjustments; adding functionality change to minimized sidebar

* ci: auto-formatting prettier issues

* Optimised images with calibre/image-actions

* Incorporating suggestions from Adelina

* 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>

* docs: Ingress TLS configuration for VM Migration Assistant (#5707)

* docs: Ingress TLS configuration for VM Migration Assistant

* docs: trigger Netlify

* ci: auto-formatting prettier issues

* docs: improve descriptions

* docs: remove array notation

* docs: fix ingress.enabled description

* DOC-1687 - Added description to the oidc syncSsoTeams field (#5718)

* DOC-1687 - Added description to the oidc syncSsoTeams field

* ci: auto-formatting API changes

---------

Co-authored-by: addetz <[email protected]>

* docs: add troubleshooting for default image endpoints DOC-1661 (#5717)

* docs: add troubleshooting for default image endpoints DOC-1661

* Apply suggestions from code review

Co-authored-by: Ben Radstone <[email protected]>
Co-authored-by: caroldelwing <[email protected]>

* ci: auto-formatting prettier issues

* docs: add closing sentence

* docs: adjust known issue text

---------

Co-authored-by: Ben Radstone <[email protected]>
Co-authored-by: caroldelwing <[email protected]>

* docs: DOC-1673: Update Open Source Licenses (#5725)

* Initial 4.6 updates for open source licenses

* Removing duplicates from PXK

* Empty commit for Netlify preview

* Incorporating additional Apache licenses from Carolina

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

* ci: auto-formatting prettier issues

---------

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

* Two node (#5595)

* docs: two node draft

* docs: add two node draft

* docs: update image formats

* docs: add failover instructions

* docs: update description

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* docs: fix links

* docs: fix broken links

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* docs: add failover instructions

* Optimised images with calibre/image-actions

* docs: clarify instructions further

* docs: correct grammar issues

* docs: minor edits

* Apply suggestions from code review

Co-authored-by: Ben Radstone <[email protected]>
Co-authored-by: caroldelwing <[email protected]>
Co-authored-by: Adelina Simion <[email protected]>

* ci: auto-formatting prettier issues

* docs: minor changes

* add ntp req

---------

Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
Co-authored-by: Ben Radstone <[email protected]>
Co-authored-by: caroldelwing <[email protected]>
Co-authored-by: Adelina Simion <[email protected]>

* docs: DOC-1578: Day-2 Cluster Profile Variables (#5593)

* Initial commit for Day-2 cluster profile variable 4.6.0 content; breaking up existing page into several smaller pages

* Correcting directory structure to preserve existing links in field

* Building out new pages with how to deploy a cluster with variables, modify variables, and delete variables

* Building out documentation for the modification page

* Solid draft of Modify page completed; validation added; several nuances added

* Complete cluster profile variables guide

* Removing <a> anchors, as they do not work with the build

* ci: auto-formatting prettier issues

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* Reworking validation section and cluster deployment; incorporating other suggestions from Carolina

* ci: auto-formatting prettier issues

* Fixing broken link

* ci: auto-formatting prettier issues

* Incorporating additional suggestions from Adelina, including minor clarifications and making the modify path more linear and condensed

* Fixing incorrect documentation stating that variables must be unique within the cluster, as it is actually within the cluster profile

* Clarifying pack.content and system.uri limitations; final cleanup

* 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>

* docs: add release notes DOC-1663 (#5692)

* docs: add release notes DOC-1663

* docs: remove empty heading and put pack notes to h4

* Apply suggestions from code review

Co-authored-by: Amanda Churi Filanowski <[email protected]>

* docs: adjust ordering of packs

* Apply suggestions from code review

Co-authored-by: caroldelwing <[email protected]>
Co-authored-by: Ben Radstone <[email protected]>

* docs: fix formatting

* docs: add terraform provider version

* ci: auto-formatting prettier issues

* docs: add pack note about pxk 1.32

* Apply suggestions from code review

Co-authored-by: Ben Radstone <[email protected]>

* docs: update feature links

* ci: auto-formatting prettier issues

* docs: update palette version

---------

Co-authored-by: Amanda Churi Filanowski <[email protected]>
Co-authored-by: caroldelwing <[email protected]>
Co-authored-by: Ben Radstone <[email protected]>

* EKS Hybrid documentation improvements (4.6.0) (#5731)

* docs: initial prepare env template

* chore: bump react-select from 5.8.0 to 5.10.0 (#5621)

Bumps [react-select](https://github.com/JedWatson/react-select) from 5.8.0 to 5.10.0.
- [Release notes](https://github.com/JedWatson/react-select/releases)
- [Changelog](https://github.com/JedWatson/react-select/blob/master/docs/CHANGELOG.md)
- [Commits](https://github.com/JedWatson/react-select/compare/[email protected]@5.10.0)

---
updated-dependencies:
- dependency-name: react-select
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: caroldelwing <[email protected]>

* chore: bump @commitlint/cli from 19.5.0 to 19.6.1 (#5620)

Bumps [@commitlint/cli](https://github.com/conventional-changelog/commitlint/tree/HEAD/@commitlint/cli) from 19.5.0 to 19.6.1.
- [Release notes](https://github.com/conventional-changelog/commitlint/releases)
- [Changelog](https://github.com/conventional-changelog/commitlint/blob/master/@commitlint/cli/CHANGELOG.md)
- [Commits](https://github.com/conventional-changelog/commitlint/commits/v19.6.1/@commitlint/cli)

---
updated-dependencies:
- dependency-name: "@commitlint/cli"
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: caroldelwing <[email protected]>

* chore: bump @mdx-js/react from 3.0.1 to 3.1.0 (#5617)

Bumps [@mdx-js/react](https://github.com/mdx-js/mdx/tree/HEAD/packages/react) from 3.0.1 to 3.1.0.
- [Release notes](https://github.com/mdx-js/mdx/releases)
- [Changelog](https://github.com/mdx-js/mdx/blob/main/changelog.md)
- [Commits](https://github.com/mdx-js/mdx/commits/3.1.0/packages/react)

---
updated-dependencies:
- dependency-name: "@mdx-js/react"
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* docs: add extra sentence, fix command (#5669)

* chore: bump @argos-ci/playwright from 2.0.0 to 4.1.0 (#5619)

Bumps [@argos-ci/playwright](https://github.com/argos-ci/argos-javascript/tree/HEAD/packages/playwright) from 2.0.0 to 4.1.0.
- [Release notes](https://github.com/argos-ci/argos-javascript/releases)
- [Changelog](https://github.com/argos-ci/argos-javascript/blob/main/packages/playwright/CHANGELOG.md)
- [Commits](https://github.com/argos-ci/argos-javascript/commits/@argos-ci/[email protected]/packages/playwright)

---
updated-dependencies:
- dependency-name: "@argos-ci/playwright"
  dependency-type: direct:development
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: caroldelwing <[email protected]>

* Removing erroneous EOF from .arg file (#5682)

* docs: EKS cluster and EKS hybrid requirements (#5661)

* docs: EKS cluster and EKS hybrid requirements

* ci: auto-formatting prettier issues

* docs: vale suggestion

* ci: auto-formatting prettier issues

* docs: fix CNI steps

* docs: additional requirements for instance

* ci: auto-formatting prettier issues

* docs: revise minimum storage for eks nodes

* docs: finalise recommended storage for eks workers

* docs: adjust release note to include control plane resize operations (#5683)

* docs: adjust release note to include control plane resize operations

* Update docs/docs-content/release-notes/release-notes.md

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

* docs: update wording release notes

---------

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

* docs: agent mode drafting

* docs: minor EKS description change (#5689)

* chore: bump semver from 7.6.3 to 7.7.1 (#5654)

Bumps [semver](https://github.com/npm/node-semver) from 7.6.3 to 7.7.1.
- [Release notes](https://github.com/npm/node-semver/releases)
- [Changelog](https://github.com/npm/node-semver/blob/main/CHANGELOG.md)
- [Commits](npm/node-semver@v7.6.3...v7.7.1)

---
updated-dependencies:
- dependency-name: semver
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: caroldelwing <[email protected]>

* docs: finalise agent mode draft

* docs: add os upgrades guide DOC-1533 (#5647)

* docs: add os upgrades guide DOC-1533

* docs: change phrasing and add reboot

* ci: auto-formatting prettier issues

* remove shorthand

* Apply suggestions from code review

Co-authored-by: Lenny Chen <[email protected]>

* Apply suggestions from code review

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

* ci: auto-formatting prettier issues

* docs: fix indentation of cat command

* docs: add changes from review

* docs: shorten output

* docs: address comments from review

* docs: changes for review DOC-1533

---------

Co-authored-by: Lenny Chen <[email protected]>
Co-authored-by: caroldelwing <[email protected]>

* docs: Appliance Mode step for hybrid pool creation (#5704)

* docs: Appliance Mode step for hybrid pool creation

* ci: auto-formatting prettier issues

* docs: fix prettier formatting

* Apply suggestions from code review

Co-authored-by: Amanda Churi Filanowski <[email protected]>

---------

Co-authored-by: Amanda Churi Filanowski <[email protected]>

* docs: update the release preview workflow to more specific branch matching (#5693)

* docs: appliance mode draft and other edits

* docs: finalise appliance mode and refactoring

* docs: add notes for patch 4.5.22 DOC-1692 (#5720)

* docs: add notes for patch 4.5.22 DOC-1692

* ci: auto-formatting prettier issues

* Update webhook-disable.md (#5598)

* Update webhook-disable.md

Per Customer:
Step 9 is missing the “files” line (I added line 3 to show):

stages:
  reconcile:
   - files
      - name: "Redirect registries"
         - path: /etc/containerd/certs.d/gcr.io/hosts.toml
           owner: 0
           group: 0
           permissions: 0644
           content: |-
             server = "https://gcr.io"
             [host."https://gcr-io-mirror.company.local"]
                 capabilities = ["pull", "resolve"]

* Update docs/docs-content/clusters/edge/site-deployment/deploy-custom-registries/webhook-disable.md

* Update webhook-disable.md

* docs: fix indentation

---------

Co-authored-by: Adelina Simion <[email protected]>
Co-authored-by: Lenny Chen <[email protected]>
Co-authored-by: Lenny Chen <[email protected]>

* docs: update 4.5.21 upgrade paths and helm paths (#5722)

* docs: DOC-1634: Calico Memory Leak and Palette Workload Clusters (#5726)

* Update to known issue specifying all Palette workload clusters are affected

* ci: auto-formatting prettier issues

---------

Co-authored-by: achuribooks <[email protected]>

* Removing internet connectivity limitation from Palette CLI ec command (#5728)

* docs: fix missing file extension from link

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: caroldelwing <[email protected]>
Co-authored-by: Amanda Churi Filanowski <[email protected]>
Co-authored-by: Adelina Simion <[email protected]>
Co-authored-by: Lenny Chen <[email protected]>
Co-authored-by: hausmckinney <[email protected]>
Co-authored-by: Lenny Chen <[email protected]>
Co-authored-by: achuribooks <[email protected]>

* docs: move branch 4.4 to legacy (#5738)

* docs: update palette cli and spectro cli (#5719)

* docs: update palette cli and spectro cli

* docs: update component table

* docs: update ova list

* docs: update additional packs

* docs: update spectro-registry path

* docs: update packs list and k8s requirements table

* docs: apply suggestions from review

* docs: update upgrade path (#5758)

* docs: update upgrade path

* docs: update 4.6.6 references

* docs: add nvidia gpu pack

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: Amanda Churi Filanowski <[email protected]>
Co-authored-by: achuribooks <[email protected]>
Co-authored-by: caroldelwing <[email protected]>
Co-authored-by: Adelina Simion <[email protected]>
Co-authored-by: Ravikumar Kondepati <[email protected]>
Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
Co-authored-by: Ben Radstone <[email protected]>
Co-authored-by: Lenny Chen <[email protected]>
Co-authored-by: Ben Radstone <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: hausmckinney <[email protected]>
Co-authored-by: Lenny Chen <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants