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

Merged
merged 2 commits into from
Jan 24, 2025

Conversation

tchughesiv
Copy link
Contributor

@tchughesiv tchughesiv commented Dec 3, 2024

What this PR does / why we need it:

This PR will demonstrate how to install and use Feast on Kubernetes with the Feast Go Operator. It uses the "Real-time Credit Scoring" tutorial as well.
https://github.com/feast-dev/feast-credit-score-local-tutorial

With this PR, we'll also begin generating API reference documentation.

@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

@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!

@tchughesiv tchughesiv force-pushed the deploy-docs-new2 branch 2 times, most recently from 0240973 to d548f62 Compare January 14, 2025 20:53
@tchughesiv tchughesiv force-pushed the deploy-docs-new2 branch 9 times, most recently from 29d8b14 to 1b37777 Compare January 24, 2025 00:40
@tchughesiv tchughesiv marked this pull request as ready for review January 24, 2025 00:43
@tchughesiv tchughesiv enabled auto-merge (squash) January 24, 2025 19:09
Copy link
Contributor

@redhatHameed redhatHameed left a comment

Choose a reason for hiding this comment

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

lgtm

@tchughesiv tchughesiv merged commit f03f097 into feast-dev:master Jan 24, 2025
24 checks passed
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.

3 participants