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

Updates to deployment guides #3994

Merged
merged 24 commits into from
Oct 7, 2023
Merged

Updates to deployment guides #3994

Show file tree
Hide file tree
Changes from 22 commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
db159e1
Updates to deployment guides
davidmirror-ops Aug 28, 2023
4063745
Update multicluster docs round 2
davidmirror-ops Sep 19, 2023
d36e9dc
Updates instructions from last run
davidmirror-ops Sep 28, 2023
08692a7
Add instructions to add clusters
davidmirror-ops Sep 29, 2023
be2abfd
Fix typos
davidmirror-ops Sep 29, 2023
4c51dc2
Fix JSON indentation in example
davidmirror-ops Sep 29, 2023
70737b7
Fix JSON indentation in example 2nd try
davidmirror-ops Sep 29, 2023
bb25ab6
Fix JSON missing blank line
davidmirror-ops Sep 29, 2023
cf77de9
Fix JSON missing blank line 3rd try
davidmirror-ops Sep 29, 2023
56cfed8
Fix JSON missing blank line 4th try
davidmirror-ops Sep 29, 2023
828359b
Fix JSON syntax
davidmirror-ops Sep 29, 2023
c7f7e3e
Fix JSON syntax 6th try
davidmirror-ops Sep 29, 2023
18f0fc8
Remove JSON block
davidmirror-ops Oct 2, 2023
e5cea21
Fix error in line 57
davidmirror-ops Oct 3, 2023
e9b685b
Fix spelling
davidmirror-ops Oct 3, 2023
b257695
Apply feedback from review
davidmirror-ops Oct 3, 2023
ee5c001
Fix hyperlink
davidmirror-ops Oct 3, 2023
7db1b7f
Fix blank space
davidmirror-ops Oct 3, 2023
0e2d871
Incorporate review
davidmirror-ops Oct 3, 2023
9199f41
Incorporate 2nd round of review
davidmirror-ops Oct 4, 2023
db07bab
Instructions using 2 IAM Roles
davidmirror-ops Oct 4, 2023
83d8c35
Incorporate 3rd round of feedback
davidmirror-ops Oct 5, 2023
e784efd
Add instructions to enable controlplane wf execution
davidmirror-ops Oct 5, 2023
fb0bb64
Incorporate 4th round of reviews
davidmirror-ops Oct 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion charts/flyte-binary/eks-production.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ ingress:
nginx.ingress.kubernetes.io/app-root: /console
grpcAnnotations:
nginx.ingress.kubernetes.io/backend-protocol: GRPC
host: development.uniondemo.run
host: development.uniondemo.run # change for the URL you'll use to connect to Flyte
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 make this an inexistent url? Maybe rename this to '<your.flyte.url>' ?

rbac:
extraRules:
- apiGroups:
Expand Down
52 changes: 35 additions & 17 deletions rsts/deployment/deployment/cloud_production.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,23 +23,48 @@ guide already contains the ingress rules, but they are not enabled by default.

To turn on ingress, update your ``values.yaml`` file to include the following block.

.. tabbed:: AWS - ``flyte-binary``
.. tabs::

.. group-tab:: ``flyte-binary`` on EKS using NGINX

.. literalinclude:: ../../../charts/flyte-binary/eks-production.yaml
:caption: charts/flyte-binary/eks-production.yaml
:language: yaml
:lines: 123-131
.. literalinclude:: ../../../charts/flyte-binary/eks-production.yaml
:caption: charts/flyte-binary/eks-production.yaml
:language: yaml
:lines: 127-135

.. group-tab:: ``flyte-binary``/ on EKS using ALB

.. code-block:: yaml

ingress:
create: true
commonAnnotations:
alb.ingress.kubernetes.io/certificate-arn: '<your-SSL-certificate-ARN>'
alb.ingress.kubernetes.io/group.name: flyte
alb.ingress.kubernetes.io/listen-ports: '[{"HTTP": 80}, {"HTTPS":443}]'
alb.ingress.kubernetes.io/scheme: internet-facing
alb.ingress.kubernetes.io/ssl-redirect: '443'
alb.ingress.kubernetes.io/target-type: ip
kubernetes.io/ingress.class: alb
httpAnnotations:
alb.ingress.kubernetes.io/actions.app-root: '{"Type": "redirect", "RedirectConfig": {"Path": "/console", "StatusCode": "HTTP_302"}}'
grpcAnnotations:
alb.ingress.kubernetes.io/backend-protocol-version: GRPC
host: <your-URL> #use a DNS CNAME pointing to your ALB

.. group-tab:: ``flyte-core`` on GCP using NGINX

.. literalinclude:: ../../../charts/flyte-core/values-gcp.yaml
:caption: charts/flyte-core/values-gcp.yaml
:language: yaml
:lines: 156-164

.. note::

This currently assumes that you have nginx ingress. We'll be updating these
in the near future to use the ALB ingress controller instead.

***************
Authentication
***************

Authentication comes with Flyte in the form of OAuth 2. Please see the
Authentication comes with Flyte in the form of OAuth 2.0. Please see the
`authentication guide <deployment-configuration-auth-setup>`__ for instructions.

.. note::
Expand All @@ -60,10 +85,3 @@ compatibility being maintained, for the most part.

If you're using the :ref:`multi-cluster <deployment-deployment-multicluster>`
deployment model for Flyte, components should be upgraded together.

.. note::

Expect to see minor version releases roughly 4-6 times a year - we aim to
release monthly, or whenever there is a large enough set of features to
warrant a release. Expect to see patch releases at more regular intervals,
especially for flytekit, the Python SDK.
8 changes: 8 additions & 0 deletions rsts/deployment/deployment/cloud_simple.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,14 @@ hello world example:
cd flytesnacks/cookbook
pyflyte run --remote core/flyte_basics/hello_world.py my_wf

***********************************
Flyte in on-premises infrastructure
***********************************

Sometimes, it's also helpful to be able to set up a Flyte environment in an on-premises Kubernetes environment or even on a laptop for testing and development purposes.
Check out `this community-maintained tutorial <https://github.com/davidmirror-ops/flyte-the-hard-way/blob/main/docs/on-premises/001-configure-local-k8s.md>`__ to learn how to setup the required dependencies and deploy the `flyte-binary` chart to a local Kubernetes cluster.


*************
What's Next?
*************
Expand Down
35 changes: 9 additions & 26 deletions rsts/deployment/deployment/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,29 +49,6 @@ deployment comes with a containerized `Minio <https://min.io/>`__, which offers
- **GCP**: `GCS <https://cloud.google.com/storage/>`__
- **Azure**: `Azure Blob Storage <https://azure.microsoft.com/en-us/products/storage/blobs>`__


Cluster Configuration
Copy link
Contributor

Choose a reason for hiding this comment

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

Why are we removing this section?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm just not sure how it fits here. Additionally is not clear what specific K8s resources it refers to (besides namespaces for projects, which is only an example). So this relationship between Flyte objects and K8s resources is worth documenting, but I'm not sure it fits in this sort of pre-requisites section.

=====================

Flyte configures K8s clusters to work with it. For example, as your Flyte userbase evolves, adding new projects is as
simple as registering them through the command line:

.. prompt:: bash $

flytectl create project \
--id my-flyte-project \
--name "My Flyte Project" \
--description "My first project onboarding onto Flyte"

Once you invoke this command, this project should immediately show up in the Flyte console after refreshing.

Flyte runs at a configurable cadence that ensures that all Kubernetes resources necessary for the new project are
created and new workflows can successfully be registered and executed within it.

.. note::

For more information, see :std:ref:`flytectl <flytectl:flytectl_create_project>`.

************************
Flyte Deployment Paths
************************
Expand Down Expand Up @@ -108,7 +85,10 @@ There are three different paths for deploying a Flyte cluster:
This option is appropriate if all your compute can `fit on one EKS cluster <https://docs.aws.amazon.com/eks/latest/userguide/service-quotas.html>`__ .
As of this writing, a single Flyte cluster can handle more than 13,000 nodes.

Whatever path you choose, note that ``FlytePropeller`` itself can be sharded as well, though typically it's not required.
Regardless of using single or multiple Kubernetes clusters for Flyte, note that ``FlytePropeller`` -the main data plane component- can be sharded as well if scale demands require it.
See `Automatic scale-out <https://docs.flyte.org/en/latest/deployment/configuration/performance.html#automatic-scale-out>`__ to learn more about the sharding strategy.



Helm
====
Expand Down Expand Up @@ -156,10 +136,13 @@ Deployment Tips and Tricks

Due to the many choices and constraints that you may face in your organization, the specific steps for deploying Flyte
can vary significantly. For example, which cloud platform to use is typically a big fork in the road for many, and there
are many choices to make in terms of ingresses, auth providers, and versions of different dependent libraries that
are many choices to make in terms of Ingress controllers, auth providers, and versions of different dependent libraries that
may interact with other parts of your stack.

In addition to searching and posting on the `Flyte Slack community <https://flyte-org.slack.com/archives/C01P3B761A6>`__,
Considering the above, we recommend checking out the `"Flyte The Hard Way" <https://github.com/davidmirror-ops/flyte-the-hard-way/tree/main#flyte-the-hard-way>`__ set of community-maintained tutorials that can guide you through the process of preparing the infrastructure and
Copy link
Contributor

Choose a reason for hiding this comment

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

In general I would avoid pointing to an external guide, give also that the guide you are referring to is mostly referring to the single binary deployment, which might be confusing. I think all documentation should be in one place

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Agree. A second iteration of updates to these guides should be pointed to extend the reach and make it more actionable. Also expanding the tutorial in the https://github.com/unionai-oss/deploy-flyte repo to cover flyte-core

Copy link
Contributor

Choose a reason for hiding this comment

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

what if we forked your guide, @davidmirror-ops , and moved it to flyteorg?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@eapolinario I was thinking of something similar. Moving forward, the idea is that TF is the preferred approach but a manual guide is always a good resource

deploying Flyte.

In addition to searching and posting on the `#flyte-deployment Slack channel <https://flyte-org.slack.com/archives/C01P3B761A6>`__,
we have a `Github Discussion <https://github.com/flyteorg/flyte/discussions/categories/deployment-tips-tricks>`__
section dedicated to deploying Flyte. Feel free to submit any hints you've found helpful as a discussion, ask questions,
or simply document what worked or what didn't work for you.
Expand Down
Loading
Loading