Skip to content

Commit

Permalink
Merge pull request #1 from lyft/master
Browse files Browse the repository at this point in the history
Fetch lyft/flyte master
  • Loading branch information
wild-endeavor authored Jan 11, 2021
2 parents e40f43a + 9845461 commit 3f4fff0
Show file tree
Hide file tree
Showing 6 changed files with 32 additions and 14 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@
![GitHub milestones Completed](https://img.shields.io/github/milestones/closed/lyft/flyte?style=plastic)
![GitHub next milestone percentage](https://img.shields.io/github/milestones/progress-percent/lyft/flyte/10?style=plastic)
![Twitter Follow](https://img.shields.io/twitter/follow/flyteorg?label=Follow&style=social)
[![Slack Status](https://img.shields.io/badge/slack-join_chat-white.svg?logo=slack&style=social)](https://docs.google.com/forms/d/e/1FAIpQLSf8bNuyhy7rkm77cOXPHIzCm3ApfL7Tdo7NUs6Ej2NOGQ1PYw/viewform?pli=1)
[![Slack Status](https://img.shields.io/badge/slack-join_chat-white.svg?logo=slack&style=social)](https://forms.gle/UVuek9WfBoweiqcJA)

Flyte is a container-native, type-safe workflow and pipelines platform optimized for large scale processing and machine learning written in Golang. Workflows can be written in any language, with out of the box support for Python and Java.
Flyte is a container-native, type-safe workflow and pipelines platform optimized for large scale processing and machine learning written in Golang. Workflows can be written in any language, with out of the box support for Python, Java and Scala.

# Homepage
- [flyte.org](https://flyte.org)
Expand All @@ -28,7 +28,7 @@ python, making it perfect for modern Machine Learning and Data processing pipeli
Resources that would help you get a better understanding of Flyte.

# Communication channels
- [Slack Org](https://docs.google.com/forms/d/e/1FAIpQLSf8bNuyhy7rkm77cOXPHIzCm3ApfL7Tdo7NUs6Ej2NOGQ1PYw/viewform?pli=1)
- [Slack Org](https://forms.gle/UVuek9WfBoweiqcJA)
- [Email list](https://groups.google.com/a/flyte.org/g/users)

# Biweekly Community Sync
Expand Down
2 changes: 1 addition & 1 deletion deployment/sandbox/flyte_generated.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9071,7 +9071,7 @@ spec:
value: minio
- name: MINIO_SECRET_KEY
value: miniostorage
image: minio/minio:RELEASE.2019-06-04T01-15-58Z
image: minio/minio:RELEASE.2020-12-16T05-05-17Z
name: minio
ports:
- containerPort: 9000
Expand Down
2 changes: 1 addition & 1 deletion deployment/test/flyte_generated.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1104,7 +1104,7 @@ spec:
value: minio
- name: MINIO_SECRET_KEY
value: miniostorage
image: minio/minio:RELEASE.2019-06-04T01-15-58Z
image: minio/minio:RELEASE.2020-12-16T05-05-17Z
name: minio
ports:
- containerPort: 9000
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ spec:
- name: minio-storage
emptyDir: {}
containers:
- image: "minio/minio:RELEASE.2019-06-04T01-15-58Z"
- image: "minio/minio:RELEASE.2020-12-16T05-05-17Z"
name: minio
env:
- name: MINIO_ACCESS_KEY
Expand Down
2 changes: 1 addition & 1 deletion kustomize/overlays/test/dependencies/storage/storage.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ spec:
- name: minio-storage
emptyDir: {}
containers:
- image: "minio/minio:RELEASE.2019-06-04T01-15-58Z"
- image: "minio/minio:RELEASE.2020-12-16T05-05-17Z"
name: minio
env:
- name: MINIO_ACCESS_KEY
Expand Down
32 changes: 25 additions & 7 deletions rsts/administrator/install/getting_started.rst
Original file line number Diff line number Diff line change
@@ -1,31 +1,43 @@
.. _getting_started:

####################
Getting Started
---------------
####################

*************
Prerequisites
*************

Kubernetes and its ``kubectl`` client are the only strict prerequisites to installing Flyte.

Kubernetes can be installed on your local machine to run Flyte locally, or in the cloud for a scalable multi-user setup. Some installation options are listed below.

Local:
Local
======

Linux
-------
For Linux, you'll need to have Docker set up. For the local Kubernetes cluster itself, we've found that `KinD <https://kind.sigs.k8s.io/docs/user/quick-start>` works better than MicroK8s, but this may change in the future. Minikube should also work.

.. note:: The Docker daemon typically runs as root in Linux (though there is a new option for running it rootless - we haven't tested that with KinD yet, so it may or may not work). Because of this, you may want to use ``sudo /full/path/to/kind`` and prepend sudo to your kubectl commands as well.

- `Minikube <https://kubernetes.io/docs/tasks/tools/install-minikube/>`_
- `Docker for Mac <https://blog.docker.com/2018/01/docker-mac-kubernetes/>`_
Mac OS
---------
For Macs, we recommend `Docker Desktop <https://www.docker.com/products/docker-desktop>`_. Docker Desktop ships with a Kubernetes cluster, which is the easiest option to use. One can also use KinD.

Cloud Providers:

Cloud Providers
================

- `AWS EKS <https://aws.amazon.com/eks/>`_ (Amazon)
- `GCP GKE <https://cloud.google.com/kubernetes-engine/>`_ (Google)
- `Azure AKS <https://azure.microsoft.com/en-us/services/kubernetes-service/>`_ (Microsoft)

Once you have kubernetes set up and can access it with ``kubectl cluster-info``, you're ready to deploy flyte.
Once you have kubernetes set up and can access it with ``kubectl cluster-info``, you're ready to deploy Flyte.

Flyte has a few different deployment configurations. We'll start with the easiest, and expand on it to increase scale and reliability.


******************
Sandbox Deployment
******************

Expand All @@ -38,6 +50,12 @@ Once deployed, you can access the Flyte console on any kubernetes node at ``http

For local deployments, this endpoint is typically http://localhost:30081/console.

For Linux, you'll need to forward the port over before being able to hit that link with your browser ::

# See note above on sudo
sudo kubectl -n flyte port-forward service/contour 30081:80


(for Minikube deployment, you need to run ``minikube tunnel`` and use the ip that Minikube tunnel outputs)

WARNING:
Expand Down

0 comments on commit 3f4fff0

Please sign in to comment.