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.

Sign up for GitHub

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

Jump to bottom

Refresh IBM guide to use Kubernetes and Postgres #49018

Merged
merged 8 commits into from
Jan 22, 2025
Merged

Refresh IBM guide to use Kubernetes and Postgres #49018

merged 8 commits into from
Jan 22, 2025

Conversation

hugoShaka
Copy link
Contributor

The v17 test plan showed that the IBM guide was not up-to-date. This PR:

  • refreshes the guide and its screenshots
  • makes the guide a proper step by step guide
  • uses Kubernetes and the teleport-cluster Helm chart
  • uses Postgres instead of etcd (supports audit logs, easier to setup and operate, better UX, better scalability)

Fixes #37059
Fixes #31870
Related to #22611

@hugoShaka hugoShaka added documentation test-plan-problem Issues which have been surfaced by running the manual release test plan labels Nov 14, 2024
@hugoShaka hugoShaka added the no-changelog Indicates that a PR does not require a changelog entry label Nov 14, 2024
@hugoShaka hugoShaka mentioned this pull request Nov 14, 2024
Closed
hugoShaka
hugoShaka commented Nov 14, 2024
View reviewed changes
docs/pages/admin-guides/deploy-a-cluster/helm-deployments/ibm.mdx

Create a release from the chart:
```code
$ helm upgrade --install -n teleport-cluster teleport teleport/teleport-cluster --version "TODO REPLACE ME" -f values.yaml
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Missing palceholder

@hugoShaka hugoShaka requested a review from espadolini November 15, 2024 18:27
espadolini
espadolini approved these changes Nov 18, 2024
View reviewed changes
docs/pages/admin-guides/deploy-a-cluster/helm-deployments/ibm.mdx
```
- create a `teleport` user and set its password
```code
# set the same password as the replication user
Copy link
Contributor

Choose a reason for hiding this comment

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

Are we ok with this? We could have a passfile with different passwords for the two users, which would also get rid of the global PGPASSWORD envvar.

ptgott
ptgott reviewed Nov 19, 2024
View reviewed changes
Copy link
Contributor

@ptgott ptgott left a comment

Choose a reason for hiding this comment

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

It looks like there's at least one redirect destination assigned to /admin-guides/deploy-a-cluster/deployments/ibm/ that we'll need to change to point to the Helm guide—once that's done, I'll take a look at the preview!

@github-actions GitHub Actions
Copy link

🤖 Vercel preview here: https://docs-on2eo06qf-goteleport.vercel.app/docs

@hugoShaka hugoShaka requested a review from ptgott November 20, 2024 20:26
r0mant
r0mant approved these changes Nov 22, 2024
View reviewed changes
docs/pages/admin-guides/deploy-a-cluster/helm-deployments/ibm.mdx Outdated Show resolved Hide resolved
docs/pages/admin-guides/deploy-a-cluster/helm-deployments/ibm.mdx Outdated Show resolved Hide resolved
docs/pages/admin-guides/deploy-a-cluster/helm-deployments/ibm.mdx Outdated Show resolved Hide resolved
docs/pages/admin-guides/deploy-a-cluster/helm-deployments/ibm.mdx Outdated Show resolved Hide resolved
docs/pages/admin-guides/deploy-a-cluster/helm-deployments/ibm.mdx Outdated Show resolved Hide resolved
docs/pages/admin-guides/deploy-a-cluster/helm-deployments/ibm.mdx Outdated Show resolved Hide resolved
docs/pages/admin-guides/deploy-a-cluster/helm-deployments/ibm.mdx Outdated Show resolved Hide resolved
docs/pages/admin-guides/deploy-a-cluster/helm-deployments/ibm.mdx Outdated Show resolved Hide resolved
@public-teleport-github-review-bot public-teleport-github-review-bot bot removed the request for review from xinding33 November 22, 2024 20:17
@zmb3
Copy link
Collaborator

zmb3 commented Jan 20, 2025

Can we get this one merged?

@hugoShaka
Copy link
Contributor Author

hugoShaka commented Jan 21, 2025 •
edited
Loading

Can we get this one merged?

I was waiting for the docs review. Now with the new docs policy I can rebase and merge. Will do.

@hugoShaka hugoShaka force-pushed the hugo/refresh-ibm-guide branch from e6fb661 to 5c83d8a Compare January 21, 2025 23:01
@github-actions GitHub Actions
Copy link

github-actions bot commented Jan 21, 2025 •
edited
Loading

Amplify deployment status

Branch Commit Job ID Status Preview Updated (UTC)
hugo/refresh-ibm-guide 72ae96a 4 ✅SUCCEED hugo-refresh-ibm-guide 2025-01-21 23:37:33

@mmcallister mmcallister added this pull request to the merge queue Jan 21, 2025
Merged via the queue into master with commit 37fbe35 Jan 22, 2025
41 of 42 checks passed
@mmcallister mmcallister deleted the hugo/refresh-ibm-guide branch January 22, 2025 00:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@espadolini espadolini espadolini approved these changes

@r0mant r0mant r0mant approved these changes

@ptgott ptgott Awaiting requested review from ptgott

Assignees
No one assigned
Labels
documentation no-changelog Indicates that a PR does not require a changelog entry size/sm test-plan-problem Issues which have been surfaced by running the manual release test plan
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

IBM docs are not up-to-date, etcd login fails Running Teleport on IBM Cloud with a PostgreSQL backend
6 participants
@hugoShaka @zmb3 @r0mant @espadolini @ptgott @mmcallister