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

[Kubernetes provider]Update kubernetes provider README #5990

Merged
merged 17 commits into from
Nov 22, 2024
Merged

[Kubernetes provider]Update kubernetes provider README #5990

merged 17 commits into from
Nov 22, 2024

Conversation

MichaelKatsoulis
Copy link
Contributor

What does this PR do?

This PR updates the README of Kubernetes Provider. It was created years ago and is out of date. It includes high level information and configuration options of Kubernetes Provider.

Why is it important?

The information provided in the README are out of date and can confuse a lot of readers.

Checklist

  • My code follows the style guidelines of this project
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have made corresponding change to the default configuration files
  • I have added tests that prove my fix is effective or that my feature works
  • I have added an entry in ./changelog/fragments using the changelog tool
  • I have added an integration test or an E2E test

@MichaelKatsoulis MichaelKatsoulis requested a review from a team as a code owner November 11, 2024 12:54
@MichaelKatsoulis MichaelKatsoulis self-assigned this Nov 11, 2024
@mergify Mergify
Copy link
Contributor

mergify bot commented Nov 11, 2024

This pull request does not have a backport label. Could you fix it @MichaelKatsoulis? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-./d./d is the label to automatically backport to the 8./d branch. /d is the digit

@mergify Mergify
Copy link
Contributor

mergify bot commented Nov 11, 2024

backport-v8.x has been added to help with the transition to the new branch 8.x.
If you don't need it please use backport-skip label and remove the backport-8.x label.

@mergify mergify bot added the backport-8.x Automated backport to the 8.x branch with mergify label Nov 11, 2024
blakerouse
blakerouse approved these changes Nov 12, 2024
View reviewed changes
Copy link
Contributor

@blakerouse blakerouse left a comment

Choose a reason for hiding this comment

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

A very nice improvement, thank you.

internal/pkg/composable/providers/kubernetes/README.md Show resolved Hide resolved
internal/pkg/composable/providers/kubernetes/README.md Show resolved Hide resolved
@MichaelKatsoulis MichaelKatsoulis requested a review from a team as a code owner November 19, 2024 08:36
swiatekm
swiatekm approved these changes Nov 21, 2024
View reviewed changes
internal/pkg/composable/providers/kubernetes/README.md
co.elastic.hints/info.period: 5m
```

In order to enable hints based autodiscover, user needs to uncomment the following lines in the [Elastic Agent Standalone manifest](https://github.com/elastic/elastic-agent/blob/main/deploy/kubernetes/elastic-agent-standalone-kubernetes.yaml)
Copy link
Contributor

Choose a reason for hiding this comment

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

@pkoutsovasilis we should make a note to update this with Helm Chart specific instructions after it's released.

@MichaelKatsoulis
Copy link
Contributor Author

/test

@gizas gizas added backport-8.16 Automated backport with mergify backport-8.15 Automated backport to the 8.15 branch with mergify labels Nov 22, 2024
@elastic-sonarqube Elastic SonarQube
Copy link

Quality Gate passed Quality Gate passed

Issues
0 New issues
0 Fixed issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarQube

@MichaelKatsoulis MichaelKatsoulis enabled auto-merge (squash) November 22, 2024 10:17
@MichaelKatsoulis MichaelKatsoulis merged commit 524c403 into elastic:main Nov 22, 2024
17 checks passed
mergify bot pushed a commit that referenced this pull request Nov 22, 2024
@MichaelKatsoulis @mergify
[Kubernetes provider]Update kubernetes provider README (#5990)
ac8ae56 
* Update kubernetes provider documentation
---------

Co-authored-by: Panos Koutsovasilis <koutsobill@hotmail.com>
Co-authored-by: Mikołaj Świątek <mail@mikolajswiatek.com>
Co-authored-by: Andrzej Stencel <andrzej.stencel@elastic.co>
(cherry picked from commit 524c403)
mergify bot pushed a commit that referenced this pull request Nov 22, 2024
@MichaelKatsoulis @mergify
[Kubernetes provider]Update kubernetes provider README (#5990)
401b80d 
* Update kubernetes provider documentation
---------

Co-authored-by: Panos Koutsovasilis <koutsobill@hotmail.com>
Co-authored-by: Mikołaj Świątek <mail@mikolajswiatek.com>
Co-authored-by: Andrzej Stencel <andrzej.stencel@elastic.co>
(cherry picked from commit 524c403)
This was referenced Nov 22, 2024
Merged
Merged
mergify bot pushed a commit that referenced this pull request Nov 22, 2024
@MichaelKatsoulis @mergify
[Kubernetes provider]Update kubernetes provider README (#5990)
1abd857 
* Update kubernetes provider documentation
---------

Co-authored-by: Panos Koutsovasilis <koutsobill@hotmail.com>
Co-authored-by: Mikołaj Świątek <mail@mikolajswiatek.com>
Co-authored-by: Andrzej Stencel <andrzej.stencel@elastic.co>
(cherry picked from commit 524c403)
@mergify mergify bot mentioned this pull request Nov 22, 2024
Merged
7 tasks
@pierrehilbert
Copy link
Contributor

@MichaelKatsoulis as this is only updating our README, shouldn't we also backport this to 8.17?

@MichaelKatsoulis
Copy link
Contributor Author

MichaelKatsoulis commented Nov 25, 2024 •
edited
Loading

@MichaelKatsoulis as this is only updating our README, shouldn't we also backport this to 8.17?

Yes, 8.17 was just forgotten. I will add it.
@pierrehilbert in all the backport PRs I see some buildkite/elastic-agent failures due to

Required status check "buildkite/elastic-agent" was not set by the expected GitHub app.

Does anyone of your team know what is wrong?

@MichaelKatsoulis MichaelKatsoulis added the backport-8.17 Automated backport with mergify label Nov 25, 2024
mergify bot pushed a commit that referenced this pull request Nov 25, 2024
@MichaelKatsoulis @mergify
[Kubernetes provider]Update kubernetes provider README (#5990)
fdd74ce 
* Update kubernetes provider documentation
---------

Co-authored-by: Panos Koutsovasilis <koutsobill@hotmail.com>
Co-authored-by: Mikołaj Świątek <mail@mikolajswiatek.com>
Co-authored-by: Andrzej Stencel <andrzej.stencel@elastic.co>
(cherry picked from commit 524c403)
@mergify mergify bot mentioned this pull request Nov 25, 2024
Merged
7 tasks
pierrehilbert pushed a commit that referenced this pull request Nov 25, 2024
@mergify @MichaelKatsoulis
[Kubernetes provider]Update kubernetes provider README (#5990) (#6123)
dda8732 
* Update kubernetes provider documentation
---------

Co-authored-by: Panos Koutsovasilis <koutsobill@hotmail.com>
Co-authored-by: Mikołaj Świątek <mail@mikolajswiatek.com>
Co-authored-by: Andrzej Stencel <andrzej.stencel@elastic.co>
(cherry picked from commit 524c403)

Co-authored-by: Michael Katsoulis <michaelkatsoulis88@gmail.com>
MichaelKatsoulis added a commit that referenced this pull request Nov 26, 2024
@mergify @MichaelKatsoulis
[Kubernetes provider]Update kubernetes provider README (#5990) (#6124)
090bfda 
* Update kubernetes provider documentation
---------

Co-authored-by: Panos Koutsovasilis <koutsobill@hotmail.com>
Co-authored-by: Mikołaj Świątek <mail@mikolajswiatek.com>
Co-authored-by: Andrzej Stencel <andrzej.stencel@elastic.co>
(cherry picked from commit 524c403)

Co-authored-by: Michael Katsoulis <michaelkatsoulis88@gmail.com>
MichaelKatsoulis added a commit that referenced this pull request Dec 2, 2024
@mergify @MichaelKatsoulis
[Kubernetes provider]Update kubernetes provider README (#5990) (#6133)
2c5190e 
* Update kubernetes provider documentation
---------

Co-authored-by: Panos Koutsovasilis <koutsobill@hotmail.com>
Co-authored-by: Mikołaj Świątek <mail@mikolajswiatek.com>
Co-authored-by: Andrzej Stencel <andrzej.stencel@elastic.co>
(cherry picked from commit 524c403)

Co-authored-by: Michael Katsoulis <michaelkatsoulis88@gmail.com>
swiatekm pushed a commit that referenced this pull request Dec 3, 2024
@MichaelKatsoulis @swiatekm
[Kubernetes provider]Update kubernetes provider README (#5990)
cb6ba5e 
* Update kubernetes provider documentation
---------

Co-authored-by: Panos Koutsovasilis <koutsobill@hotmail.com>
Co-authored-by: Mikołaj Świątek <mail@mikolajswiatek.com>
Co-authored-by: Andrzej Stencel <andrzej.stencel@elastic.co>
(cherry picked from commit 524c403)
MichaelKatsoulis added a commit that referenced this pull request Dec 5, 2024
@mergify @MichaelKatsoulis
[Kubernetes provider]Update kubernetes provider README (#5990) (#6125)
470deb0 
* Update kubernetes provider documentation
---------

Co-authored-by: Panos Koutsovasilis <koutsobill@hotmail.com>
Co-authored-by: Mikołaj Świątek <mail@mikolajswiatek.com>
Co-authored-by: Andrzej Stencel <andrzej.stencel@elastic.co>
(cherry picked from commit 524c403)

Co-authored-by: Michael Katsoulis <michaelkatsoulis88@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@swiatekm swiatekm swiatekm approved these changes

@andrzej-stencel andrzej-stencel andrzej-stencel approved these changes

@pkoutsovasilis pkoutsovasilis pkoutsovasilis approved these changes

@gizas gizas gizas approved these changes

@tetianakravchenko tetianakravchenko Awaiting requested review from tetianakravchenko tetianakravchenko was automatically assigned from elastic/obs-cloudnative-monitoring

@constanca-m constanca-m Awaiting requested review from constanca-m constanca-m was automatically assigned from elastic/obs-cloudnative-monitoring

@michel-laterman michel-laterman Awaiting requested review from michel-laterman michel-laterman is a code owner automatically assigned from elastic/elastic-agent-control-plane

@blakerouse blakerouse Awaiting requested review from blakerouse

Assignees

@MichaelKatsoulis MichaelKatsoulis

Labels
backport-8.x Automated backport to the 8.x branch with mergify backport-8.15 Automated backport to the 8.15 branch with mergify backport-8.16 Automated backport with mergify backport-8.17 Automated backport with mergify Team:Cloudnative-Monitoring Label for the Cloud Native Monitoring team Team:Elastic-Agent-Control-Plane Label for the Agent Control Plane team
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
8 participants
@MichaelKatsoulis @elasticmachine @pierrehilbert @gizas @blakerouse @pkoutsovasilis @andrzej-stencel @swiatekm