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.

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

Fleet Server on kubernetes document proposal #1518

Open
wants to merge 54 commits into
base: main
Choose a base branch
from

Conversation

eedugon
Copy link
Contributor

@eedugon eedugon commented Dec 3, 2024

Adding a Deploy Fleet Server on Kubernetes document, under Deployment models section.

Preview: https://ingest-docs_bk_1518.docs-preview.app.elstc.co/guide/en/fleet/master/add-fleet-server-kubernetes.html

Copy link

github-actions bot commented Dec 3, 2024

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

Copy link
Contributor

mergify bot commented Dec 3, 2024

This pull request does not have a backport label. Could you fix it @eedugon? 🙏
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 /d./d branch. /d is the digit
    NOTE: backport-skip has been added to this pull request.

@kilfoyle
Copy link
Contributor

kilfoyle commented Dec 3, 2024

@eedugon I read through and this looks great!
Since the PR is in draft mode, should I add comments now or would you like me to wait before doing that?

@eedugon
Copy link
Contributor Author

eedugon commented Dec 3, 2024 via email

Copy link
Member

@bmorelli25 bmorelli25 left a comment

Choose a reason for hiding this comment

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

I through in a few small grammar things, but generally liking the new flow!

@eedugon eedugon changed the title [WIP] Fleet Server on kubernetes draft added Fleet Server on kubernetes draft added Dec 10, 2024
@eedugon eedugon changed the title Fleet Server on kubernetes draft added Fleet Server on kubernetes document proposal Dec 10, 2024
…ntent.asciidoc

Co-authored-by: Brandon Morelli <bmorelli25@gmail.com>
@eedugon eedugon marked this pull request as ready for review December 11, 2024 07:21
@eedugon eedugon requested a review from a team as a code owner December 11, 2024 07:21
Copy link

@laraMorenoIgle laraMorenoIgle left a comment

Choose a reason for hiding this comment

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

As we have talked in private, I suggest:

eedugon and others added 18 commits December 12, 2024 10:55
…ciidoc

Co-authored-by: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com>
…ciidoc

Co-authored-by: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com>
…ciidoc

Co-authored-by: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com>
…ciidoc

Co-authored-by: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com>
…ciidoc

Co-authored-by: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com>
…ciidoc

Co-authored-by: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com>
…ciidoc

Co-authored-by: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com>
…ciidoc

Co-authored-by: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com>
…ciidoc

Co-authored-by: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com>
…ciidoc

Co-authored-by: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com>
…ciidoc

Co-authored-by: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com>
…ciidoc

Co-authored-by: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com>
…ciidoc

Co-authored-by: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com>
…ciidoc

Co-authored-by: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com>
…ciidoc

Co-authored-by: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com>
eedugon and others added 3 commits December 30, 2024 13:51
…ciidoc

Co-authored-by: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com>
…ciidoc

Co-authored-by: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com>
@eedugon eedugon requested a review from swiatekm December 30, 2024 13:15
@eedugon
Copy link
Contributor Author

eedugon commented Dec 30, 2024

@kilfoyle, after reviewing and applying the latest updates to the doc together I'd like devs to review the content from the technical side also.

@swiatekm : would you be able to take a look and share your thoughts?

I'd like your comments around the specific proposal to install the Fleet Server on Kubernetes. We are suggesting a single
Deployment backed up by 2 secrets, one for env vars, and another one for the CA certificate of Elasticsearch. The manifest doesn't need any RBAC and we disable the token to talk to Kubernetes API because the Fleet Server doesn't need it.

If you believe there's a quicker or better approach let us know. I haven't tried the automatic Kibana Setup directly by the Agent (using KIBANA_ env vars) because I've never been able to make it working (that functionality is not properly documented either).

cc: @nimarezainia : we would also like you to review this new document :)

@swiatekm
Copy link
Contributor

swiatekm commented Jan 2, 2025

@eedugon I did a first pass review and everything looks good to me. Before approving, I'm also going to actually follow the guide as well in my test environment to see if I spot any sharp edges that way.

One note for the future is that the CA setup seems like the most complex part of the guide. While we can't do much about this when it comes to ES itself, for the connection between Fleet Server and agent, we should be able to have the Fleet Server Helm Chart generate the necessary certs, or, even better, have cert-manager do it if it's available. WDYT @pkoutsovasilis ?

Copy link
Contributor

@swiatekm swiatekm left a comment

Choose a reason for hiding this comment

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

Found a few issues, comments below.

Comment on lines +22 to +25
kubectl create secret generic fleet-server-certs \
--from-file=es-ca.crt=<PATH_TO_ES_CA_CERT_FILE> \ <1>
--from-file=fleet-server.crt=<PATH_TO_FLEET_SERVER_CERT> \ <2>
--from-file=fleet-server.key=<PATH_TO_FLEET_SERVER_CERT_KEY> <3>
Copy link
Contributor

Choose a reason for hiding this comment

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

\ <1> ends up rendering a space after each backslash, which isn't valid shell escaping, and will produce an error. Not sure how to fix it in asciidoc.

@eedugon
Copy link
Contributor Author

eedugon commented Jan 4, 2025 via email

eedugon and others added 2 commits January 7, 2025 12:28
…ntent.asciidoc

Co-authored-by: Mikołaj Świątek <mail@mikolajswiatek.com>
…ntent.asciidoc

Co-authored-by: Mikołaj Świątek <mail@mikolajswiatek.com>
@pkoutsovasilis
Copy link

sorry for the delay guys 👋 I will review this shortly 🙂

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

Successfully merging this pull request may close these issues.

6 participants