-
Notifications
You must be signed in to change notification settings - Fork 11
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: update local kubenetes configuration README.md #1928
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reviewed 1 of 1 files at r1, all commit messages.
Reviewable status: all files reviewed, 1 unresolved discussion (waiting on @roaminggypsy)
src/main/k8s/local/README.md
line 235 at r1 (raw file):
```shell kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.13.2/cert-manager.yaml
nit: also update cert manager version.
Basically, this file needs to be kept in sync with .github/actions/install-otel-operator/action.yml
Suggestion:
v1.14.5
I added some more changes covering some common operations. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reviewed all commit messages.
Reviewable status: 0 of 1 files reviewed, 4 unresolved discussions (waiting on @roaminggypsy)
src/main/k8s/local/README.md
line 55 at r2 (raw file):
Delete Existing Local Cluster
This should be moved down to the appendix as it only applies to Kind (as opposed to Minikube or K3s)
src/main/k8s/local/README.md
line 255 at r2 (raw file):
This depends on [cert-manager](https://github.com/cert-manager/cert-manager), so we install that first. Make sure their versions are the same as versions listed in [install-otel-operator/action.yml](https://github.com/world-federation-of-advertisers/cross-media-measurement/blob/6f9b14b912099d0ce0ddd02f67b67377c7a3daa9/.github/actions/install-otel-operator/action.yml#L4):
Use a relative link for anything that's in the same repo
Code quote:
(https://github.com/world-federation-of-advertisers/cross-media-measurement/blob/6f9b14b912099d0ce0ddd02f67b67377c7a3daa9/.github/actions/install-otel-operator/action.yml#L4
src/main/k8s/local/README.md
line 344 at r2 (raw file):
## Debugging Tips List cron jobs:
nit: Leave out all the common kubectl commands, or mention them very generally. These are basics, and there are more forms than are mentioned here. For example, we frequently debug Deployment objects so you're more likely to need kubectl get deployments
. We also are more likely to want to stream logs for a running Pod or Deployment, where we'd use kubectl logs -f deployments/foo
src/main/k8s/local/README.md
line 373 at r2 (raw file):
an example: kubectl edit cronjob/measurement-system-prober-cronjob ```shell
This is not a shell script, but rather a snippet from a YAML file. The above command is though. You also want to leave a blank line before/after code fences.
Suggestion:
```yaml
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reviewable status: 0 of 1 files reviewed, 3 unresolved discussions (waiting on @SanjayVas)
src/main/k8s/local/README.md
line 55 at r2 (raw file):
Previously, SanjayVas (Sanjay Vasandani) wrote…
This should be moved down to the appendix as it only applies to Kind (as opposed to Minikube or K3s)
Done.
src/main/k8s/local/README.md
line 255 at r2 (raw file):
Previously, SanjayVas (Sanjay Vasandani) wrote…
Use a relative link for anything that's in the same repo
Done.
src/main/k8s/local/README.md
line 373 at r2 (raw file):
Previously, SanjayVas (Sanjay Vasandani) wrote…
This is not a shell script, but rather a snippet from a YAML file. The above command is though. You also want to leave a blank line before/after code fences.
Done.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reviewed 1 of 1 files at r3, all commit messages.
Reviewable status: complete! all files reviewed, all discussions resolved (waiting on @roaminggypsy)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reviewed 1 of 1 files at r3, all commit messages.
Reviewable status: complete! all files reviewed, all discussions resolved (waiting on @roaminggypsy)
No description provided.