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

docs: Operator example notebook & api reference docs #4807

Draft
wants to merge 34 commits into
base: master
Choose a base branch
from

Conversation

tchughesiv
Copy link
Contributor

What this PR does / why we need it:

Which issue(s) this PR fixes:

Misc

@tchughesiv tchughesiv changed the title feat: operator example runbook & api reference docs feat: Operator example runbook & api reference docs Dec 3, 2024
@dmartinol
Copy link
Contributor

Very exhaustive showcase of the main operator deployment functions.

  • I would just add a short explanation of the feast architecture (a Topology diagram?)
  • maybe also clarify what the client pod does under the scenes with the init-containers, maybe adding the relevant snippets or short text description:
until grpcurl -insecure -d '''' -format text feast-example-registry.feast.svc.cluster.local:443 grpc.health.v1.Health/Check; do echo waiting for registry; sleep 2; done
#feast init
with mock.patch("click.prompt", side_effect=["postgres.feast.svc.cluster.local", "5432", "feast", "public", "feast", "feast"]):
  with mock.patch("click.confirm", side_effect=[True]):
    init_repo(project_directory, template)' > postgres-apply.py;
...
feast apply
...
CURRENT_TIME=$(date -u +"%Y-%m-%dT%H:%M:%S");
feast materialize-incremental $CURRENT_TIME

image

@tchughesiv tchughesiv changed the title feat: Operator example runbook & api reference docs feat: Operator example notebook & api reference docs Dec 3, 2024
@tchughesiv tchughesiv changed the title feat: Operator example notebook & api reference docs docs: Operator example notebook & api reference docs Dec 3, 2024
@dmartinol dmartinol marked this pull request as ready for review December 11, 2024 16:55
@dmartinol dmartinol requested a review from a team as a code owner December 11, 2024 16:55
@tchughesiv tchughesiv marked this pull request as draft December 11, 2024 21:00
Copy link
Contributor

Choose a reason for hiding this comment

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

can we add the few more kubectl exec commands to run sample commands like feast XYZ list to prove the repo was correctly created?

Copy link
Contributor

Choose a reason for hiding this comment

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

It seems these notebooks have no output. While I agree that maintaining outputs in git can be challenging, having the outputs preserved is indeed very helpful when the notebooks from a browser. It provides immediate insight into the results of the experiment without needing to rerun it. WDYT?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

oh ok, i hadn't thought of it that way. i'll add them

Copy link
Contributor

@dmartinol dmartinol left a comment

Choose a reason for hiding this comment

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

lgtm!

Signed-off-by: Tommy Hughes <[email protected]>
Signed-off-by: Tommy Hughes <[email protected]>
Signed-off-by: Tommy Hughes <[email protected]>
Signed-off-by: Tommy Hughes <[email protected]>
Signed-off-by: Tommy Hughes <[email protected]>
Signed-off-by: Tommy Hughes <[email protected]>
Signed-off-by: Tommy Hughes <[email protected]>
Signed-off-by: Tommy Hughes <[email protected]>
Signed-off-by: Tommy Hughes <[email protected]>
Signed-off-by: Tommy Hughes <[email protected]>
Signed-off-by: Tommy Hughes <[email protected]>
Signed-off-by: Tommy Hughes <[email protected]>
Signed-off-by: Tommy Hughes <[email protected]>
Signed-off-by: Tommy Hughes <[email protected]>
Signed-off-by: Tommy Hughes <[email protected]>
Signed-off-by: Tommy Hughes <[email protected]>
Signed-off-by: Tommy Hughes <[email protected]>
Signed-off-by: Tommy Hughes <[email protected]>
Signed-off-by: Tommy Hughes <[email protected]>
Signed-off-by: Tommy Hughes <[email protected]>
Signed-off-by: Tommy Hughes <[email protected]>
Signed-off-by: Tommy Hughes <[email protected]>
Signed-off-by: Tommy Hughes <[email protected]>
Signed-off-by: Tommy Hughes <[email protected]>
Signed-off-by: Tommy Hughes <[email protected]>
Signed-off-by: Tommy Hughes <[email protected]>
Signed-off-by: Tommy Hughes <[email protected]>
Signed-off-by: Tommy Hughes <[email protected]>
Signed-off-by: Tommy Hughes <[email protected]>
Signed-off-by: Tommy Hughes <[email protected]>
Signed-off-by: Tommy Hughes <[email protected]>
Signed-off-by: Tommy Hughes <[email protected]>
Signed-off-by: Tommy Hughes <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants