Skip to content

docs: update manual installation#384

Open
yoyocircle wants to merge 2 commits intoAzure:masterfrom
yoyocircle:docs/update-manual
Open

docs: update manual installation#384
yoyocircle wants to merge 2 commits intoAzure:masterfrom
yoyocircle:docs/update-manual

Conversation

@yoyocircle
Copy link
Copy Markdown

@yoyocircle yoyocircle commented May 14, 2024 •
edited
Loading

Reason for Change:

  1. Update the manual installation guide to make it better.
  2. add the configuration for KMS v2

Issue Fixed:

Related to #239

Notes for Reviewers:
some of contents are referred to official documents of setting up the encryption configuration.

yoyocircle added 2 commits May 14, 2024 17:59
@yoyocircle
docs: adjust used fields and fix typos
05c7b79 
Signed-off-by: yoyocircle <61043261+yoyocircle@users.noreply.github.com>
@yoyocircle
docs: update the descriptions of setting steps
8199421 
1. adjust the wrong paths
2. add description about configuring KMS v2
3. Mounting the encryption configuration is also required

Signed-off-by: yoyocircle <61043261+yoyocircle@users.noreply.github.com>
@yoyocircle yoyocircle changed the title Docs/update manual docs: update manual installation May 14, 2024
@yoyocircle
Copy link
Copy Markdown
Author

yoyocircle commented May 14, 2024

@yoyocircle please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"

Contributor License Agreement

@microsoft-github-policy-service agree

benjaminapetersen
benjaminapetersen reviewed Aug 26, 2025
View reviewed changes
docs/manual-install.md
### 4. Create encryption configuration

Create a new encryption configuration file `/etc/kubernetes/manifests/encryptionconfig.yaml` using the appropriate properties for the `kms` provider:
Create a new encryption configuration file `/etc/kubernetes/enc/encryptionconfig.yaml` using the appropriate properties for the `kms` provider:
Copy link
Copy Markdown

@benjaminapetersen benjaminapetersen Aug 26, 2025

Choose a reason for hiding this comment

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

These bits look important to get right, I imagine incorrect paths will result in a broken install. I'm not familiar off the top of my head.

@enj @aramase for 👀 ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@benjaminapetersen benjaminapetersen benjaminapetersen left review comments

@aramase aramase Awaiting requested review from aramase aramase is a code owner

@nilekhc nilekhc Awaiting requested review from nilekhc

@enj enj Awaiting requested review from enj enj is a code owner

At least 1 approving review is required to merge this pull request.

Assignees

@enj enj

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@yoyocircle @benjaminapetersen @enj @aramase