Add AKS/EKS instructions #1649
Add AKS/EKS instructions #1649
Conversation
rafaelroquetto
added
the
documentation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
docs/sources/security.md
Outdated
| @@ -68,6 +68,72 @@ Access to `CAP_PERFMON` is subject to `perf_events` access controls governed by | |||
|
|
|||
| Some Linux distributions define higher levels for `kernel.perf_event_paranoid`, for example Debian based distributions [also use](https://lwn.net/Articles/696216/) `kernel.perf_event_paranoid=3`, which disallows access to `perf_event_open()` without `CAP_SYS_ADMIN`. If you are running on a distribution with `kernel.perf_event_paranoid` setting higher than `2`, you can either modify your configuration to lower it to `2` or use `CAP_SYS_ADMIN` instead of `CAP_PERFMON`. | |||
|
|
|||
| ### Deploying on AKS/EKS | |||
There was a problem hiding this comment.
[Grafana.Gerunds] For a task-based heading, start with a bare infinitive, also known as a plain form or base form verb. In English, the imperative mood also uses the base form verb, so it looks the same as the bare infinitive. Task-based headings are frequently used in quickstarts, how-to documents, and tutorials. For a conceptual or non-task-based heading, use a noun phrase that doesn't start with an -ing verb. Noun-phrase headings are frequently used in concept documentation.
For more information, refer to https://developers.google.com/style/headings#heading-and-title-text.
If the rule is incorrect or needs improving, report an issue.
If you have reason to diverge from the style guidance, to skip a rule, refer to Skip rules.
docs/sources/security.md
Outdated
| @@ -68,6 +68,72 @@ Access to `CAP_PERFMON` is subject to `perf_events` access controls governed by | |||
|
|
|||
| Some Linux distributions define higher levels for `kernel.perf_event_paranoid`, for example Debian based distributions [also use](https://lwn.net/Articles/696216/) `kernel.perf_event_paranoid=3`, which disallows access to `perf_event_open()` without `CAP_SYS_ADMIN`. If you are running on a distribution with `kernel.perf_event_paranoid` setting higher than `2`, you can either modify your configuration to lower it to `2` or use `CAP_SYS_ADMIN` instead of `CAP_PERFMON`. | |||
|
|
|||
| ### Deploying on AKS/EKS | |||
|
|
|||
| Both AKS and EKS environments come with kernels that have `sys.perf_event_paranoid > 1` set by default, which means Beyla needs `CAP_SYS_ADMIN` to work (see [[#Performance monitoring tasks]]). If you'd prefer to use just `CAP_PERFMON`, you can configure your node to set `kernel.perf_event_paranoid = 1`. Below, we’ve provided a few examples of how to do this. Keep in mind that your results may vary depending on your specific setup. | |||
There was a problem hiding this comment.
[Grafana.SmartQuotes] Avoid smart quotes in the source file, especially in code blocks. Replace all smart double quotes like “ or ” with ". Replace all smart single quotes like ‘, ’, or ʼ with '. In some contexts, Unicode characters aren't supported and break configurations. The website renders paired quotes using smart quotes in paragraphs.
If the rule is incorrect or needs improving, report an issue.
If you have reason to diverge from the style guidance, to skip a rule, refer to Skip rules.
There was a problem hiding this comment.
The issue is likely to happen in we’ve where it should be we've. This error happens when you first write the text in rich-text editors e.g. Google Docs, and then copy paste the text here.
There was a problem hiding this comment.
Very nice catch @mariomac , thank you!
|
|
||
| Both AKS and EKS environments come with kernels that have `sys.perf_event_paranoid > 1` set by default, which means Beyla needs `CAP_SYS_ADMIN` to work (see [[#Performance monitoring tasks]]). If you'd prefer to use just `CAP_PERFMON`, you can configure your node to set `kernel.perf_event_paranoid = 1`. Below, we’ve provided a few examples of how to do this. Keep in mind that your results may vary depending on your specific setup. | ||
|
|
||
| #### AKS |
There was a problem hiding this comment.
[Grafana.Headings] Use sentence-style capitalization for 'AKS'. Vale considers multi-word exceptions such as Grafana Enterprise Metrics as a single correctly cased word. If your heading contains capitalized words that represent product names, you need to add those words to the Grafana dictionary or the list of static exceptions in https://github.com/grafana/writers-toolkit/blob/main/vale/Headings.jsonnet for them to be considered correctly cased.
For more information, refer to https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings.
If the rule is incorrect or needs improving, report an issue.
If you have reason to diverge from the style guidance, to skip a rule, refer to Skip rules.
rafaelroquetto
force-pushed
the
docs_paranoid
branch
from
fcf2639 to
b964011
Compare
rafaelroquetto
force-pushed
the
docs_paranoid
branch
from
b964011 to
21894c8
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1649 +/- ##
==========================================
+ Coverage 65.38% 72.37% +6.99%
==========================================
Files 196 197 +1
Lines 19946 19955 +9
==========================================
+ Hits 13041 14443 +1402
+ Misses 6106 4824 -1282
+ Partials 799 688 -111
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Co-authored-by: Sean Packham <[email protected]>
Co-authored-by: Sean Packham <[email protected]>
rafaelroquetto
force-pushed
the
docs_paranoid
branch
from
a57a0ac to
c7a4895
Compare
|
(Rebase) |
|
The backport to To backport manually, run these commands in your terminal: # Fetch latest updates from GitHub
git fetch
# Create a new branch
git switch --create backport-1649-to-release-2.0 origin/release-2.0
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x 11072bd713ba3af875192e307a05bb03ed73dc45When the conflicts are resolved, stage and commit the changes: If you have the GitHub CLI installed: # Push the branch to GitHub:
git push --set-upstream origin backport-1649-to-release-2.0
# Create the PR body template
PR_BODY=$(gh pr view 1649 --json body --template 'Backport 11072bd713ba3af875192e307a05bb03ed73dc45 from #1649{{ "\n\n---\n\n" }}{{ index . "body" }}')
# Create the PR on GitHub
echo "${PR_BODY}" | gh pr create --title '[release-2.0] Add AKS/EKS instructions' --body-file - --label 'documentation' --label 'backport' --label 'backport-2.0' --label 'type/docs' --base release-2.0 --milestone release-2.0 --webOr, if you don't have the GitHub CLI installed (we recommend you install it!): # Push the branch to GitHub:
git push --set-upstream origin backport-1649-to-release-2.0
# Create a pull request where the `base` branch is `release-2.0` and the `compare`/`head` branch is `backport-1649-to-release-2.0`.
# Remove the local backport branch
git switch main
git branch -D backport-1649-to-release-2.0 |
--------- Co-authored-by: Sean Packham <[email protected]> (cherry picked from commit 11072bd)
Add context and instructions for running Beyla with reduced permissions on AKS/EKS.