Remove flyte-cli references in the documentation (flyteorg#672)

* Added reuse able workflow (flyteorg#660) Signed-off-by: Yuvraj <[email protected]> Signed-off-by: Alekhya Sai Punnamaraju <[email protected]> * Add directive (flyteorg#663) Signed-off-by: SmritiSatyanV <[email protected]> Signed-off-by: Alekhya Sai Punnamaraju <[email protected]> * Added links from Flytelab (flyteorg#652) * Added link from Flytelab Added weather forecasting application link Minor grammar fixes Signed-off-by: SmritiSatyanV <[email protected]> * Created weather_forecast.rst Created rst file to add github repo to weather-forecasting, and blog Signed-off-by: SmritiSatyanV <[email protected]> * Fixed errors-1 Signed-off-by: SmritiSatyanV <[email protected]> * Updated weather_forecasting.rst Signed-off-by: SmritiSatyanV <[email protected]> * Added flytelab and blog link Added description, and right links. Signed-off-by: SmritiSatyanV <[email protected]> * Changes to tutorials.rst Placed the weather forecasting tab in a different position Signed-off-by: SmritiSatyanV <[email protected]> * updated ml_training.rst Added description for ml_training file Signed-off-by: SmritiSatyanV <[email protected]> * Changes based on review Signed-off-by: SmritiSatyanV <[email protected]> * Changed weather forecasting drop down to flytelab Signed-off-by: SmritiSatyanV <[email protected]> * Changes based on comments Signed-off-by: SmritiSatyanV <[email protected]> Signed-off-by: Alekhya Sai Punnamaraju <[email protected]> * Add AWS Batch example (flyteorg#636) * Added aws batch example Signed-off-by: Kevin Su <[email protected]> * Updated dependency Signed-off-by: Kevin Su <[email protected]> * Update dockerfile Signed-off-by: Kevin Su <[email protected]> * Fixed tests Signed-off-by: Kevin Su <[email protected]> * rerun tests Signed-off-by: Kevin Su <[email protected]> * Fixed tests Signed-off-by: Kevin Su <[email protected]> * rerun tests Signed-off-by: Kevin Su <[email protected]> * Fixed tests Signed-off-by: Kevin Su <[email protected]> * Fixed tests Signed-off-by: Kevin Su <[email protected]> * Fixed tests Signed-off-by: Kevin Su <[email protected]> * address comment Signed-off-by: Kevin Su <[email protected]> Signed-off-by: Alekhya Sai Punnamaraju <[email protected]> * Moving register files example to use flytectl Signed-off-by: Alekhya Sai Punnamaraju <[email protected]> * Update fast serialization Signed-off-by: Alekhya Sai Punnamaraju <[email protected]> * Apply suggestions from code review Co-authored-by: Samhita Alla <[email protected]> Signed-off-by: Alekhya Sai Punnamaraju <[email protected]> * Apply suggestions from code review Co-authored-by: Samhita Alla <[email protected]> Signed-off-by: Alekhya Sai Punnamaraju <[email protected]> * Updated index.rst (flyteorg#670) rephrased a sentence Signed-off-by: SmritiSatyanV <[email protected]> Signed-off-by: Alekhya Sai Punnamaraju <[email protected]> * Minor updates (flyteorg#669) * Minor updates Grammar, and rendering fix Updates based on comments Update contribute.rst Signed-off-by: SmritiSatyanV <[email protected]> * Moving panel-and-toc image to static-resources repo and updating the url (flyteorg#671) Co-authored-by: Alekhya Sai <[email protected]> Signed-off-by: Alekhya Sai Punnamaraju <[email protected]> * Update backend_plugins.py (flyteorg#653) Signed-off-by: Alekhya Sai Punnamaraju <[email protected]> * Update fast_registration.py Signed-off-by: Alekhya Sai Punnamaraju <[email protected]> * Update flyte_python_types.py iteration 1 Signed-off-by: Alekhya Sai Punnamaraju <[email protected]> * Remove flyte-cli references Signed-off-by: Alekhya Sai Punnamaraju <[email protected]> * Remove fast_registration.py in favor of deploying_workflows.py Signed-off-by: Alekhya Sai Punnamaraju <[email protected]> * Rewording a few sentences Signed-off-by: Alekhya Sai Punnamaraju <[email protected]> * Add new line Signed-off-by: Alekhya Sai Punnamaraju <[email protected]> * Remove references from lp_schedules.py Signed-off-by: Alekhya Sai Punnamaraju <[email protected]> * Update instructions Signed-off-by: Alekhya Sai Punnamaraju <[email protected]> * Update settings commnent Signed-off-by: Alekhya Sai Punnamaraju <[email protected]> * Worked on review suggestions Signed-off-by: Alekhya Sai Punnamaraju <[email protected]> * Add alternative option Signed-off-by: Alekhya Sai Punnamaraju <[email protected]> Co-authored-by: Yuvraj <[email protected]> Co-authored-by: SmritiSatyanV <[email protected]> Co-authored-by: Kevin Su <[email protected]> Co-authored-by: Samhita Alla <[email protected]> Co-authored-by: Niels Bantilan <[email protected]>
eapolinario · Mar 7, 2022 · ac979a7 · ac979a7
1 parent 88d248d
commit ac979a7
Show file tree

Hide file tree

Showing 7 changed files with 15 additions and 164 deletions.
diff --git a/cookbook/common/leaf.mk b/cookbook/common/leaf.mk
@@ -24,7 +24,7 @@ export FLYTE_AWS_ACCESS_KEY_ID ?= minio
 # Used to authenticate to s3. For a production AWS S3, it's discouraged to use keys and key ids.
 export FLYTE_AWS_SECRET_ACCESS_KEY ?= miniostorage
 
-# Instructs flyte-cli commands to use insecure channel when communicating with Flyte's control plane.
+# Instructs flytectl commands to use insecure channel when communicating with Flyte's control plane.
 # If you're port-forwarding your service or running the sandbox Flyte deployment, specify INSECURE=1 before your make command.
 # If your Flyte Admin is behind SSL, don't specify anything.
 ifndef INSECURE

diff --git a/cookbook/core/scheduled_workflows/lp_schedules.py b/cookbook/core/scheduled_workflows/lp_schedules.py
@@ -111,49 +111,20 @@ def positive_wf(name: str):
 #   pyflyte lp -p {{ your project }} -d {{ your domain }} activate-all
 
 # %%
-# (or)
+# or with Flytectl:
 #
-# With flyte-cli:
-#
-# - View and activate launch plans: flyte-cli -i -h localhost:30081 -p flyteexamples -d development list-launch-plan-versions
+# - Activate launch plan:
 #
 # .. code-block:: bash
 #
-#   flyte-cli -i -h localhost:30081 -p flyteexamples -d development list-launch-plan-versions
+#   flytectl update launchplan -p flyteexamples -d development {{ name_of_lp }} --activate
 
 # %%
-# - Extract the URN returned for the launch plan you're interested in and make the call to activate it:
+# - Verify if your launch plan got activated:
 #
 # .. code-block:: bash
 #
-#   flyte-cli update-launch-plan -i -h localhost:30081 --state active -u {{ urn }}
-#
-# .. tip::
-#   The equivalent command in `flytectl <https://docs.flyte.org/projects/flytectl/en/latest/index.html>`__ is:
-#
-#   .. code-block:: bash
-#
-#       flytectl update launchplan -p flyteexamples -d development {{ name_of_lp }} --activate``
-#
-#   Example:
-#
-#   .. code-block:: bash
-#
-#       flytectl update launchplan -p flyteexamples -d development core.basic.lp.go_greet --activate
-
-# %%
-# - Verify your active launch plans:
-#
-# .. code-block:: bash
-#
-#   flyte-cli -i -h localhost:30081 -p flyteexamples -d development list-active-launch-plans
-#
-# .. tip::
-#   The equivalent command in `flytectl <https://docs.flyte.org/projects/flytectl/en/latest/index.html>`__ is:
-#
-#   .. code-block:: bash
-#
-#       flytectl get launchplan -p flytesnacks -d development``
+#   flytectl get launchplan -p flytesnacks -d development
 
 # %%
 # Platform Configuration Changes For AWS Scheduler

diff --git a/cookbook/core/type_system/flyte_python_types.py b/cookbook/core/type_system/flyte_python_types.py
@@ -90,34 +90,4 @@
      - Custom Transformers
      - Use python 3 type hints. We use `FlytePickle transformer <flyte_pickle.html>`_ by default, but users still can provide custom transformers. Refer to :ref:`advanced_custom_types`.
 
-
-.. prompt:: bash
-
-    flyte-cli -h localhost:30081 -i list-launch-plan-versions -p flytesnacks -d development | grep PrimitiveDemoWorkflow
-    flyte-cli -h localhost:30081 -i execute-launch-plan -p flytesnacks -d development -u <urn> -r user -- x=10 y=10.0 s="Hello" b=True
-
-To retrieve the right LaunchPlan Urn:
-
-.. prompt:: bash
-
-    flyte-cli -h localhost:30081 -i list-launch-plan-versions -p flytesnacks -d development | grep TimeDemoWorkflow
-
-Then take the URN and plug here
-
-.. prompt:: bash
-
-    flyte-cli -h localhost:30081 -i execute-launch-plan -p flytesnacks -d development -u <urn> -r kumare -- dt=20200707T00:00Z duration=10H
-
-The CLI accepts *datetime* and *duration* fields in [RFC3339](https://tools.ietf.org/html/rfc3339 ) formats, which is
-usually of the form **YYYYMMDDTHH:MM:SSZ** ``(z -> timezone)``. Duration is of the format **10H** (for 10 hours) or **10S**
-or **2D** (days etc)
-
-.. prompt:: bash
-
-    flyte-cli -p flytesnacks \
-        -d development execute-launch-plan \
-        -u lp:flytesnacks:development:types.generic.GenericDemoWorkflow:version \
-        -r demo \
-        -- a='{"a": "hello", "b": "how are you", "c": ["array"], "d": {"nested": "value"}}'
-
 """
diff --git a/cookbook/deployment/deploying_workflows.py b/cookbook/deployment/deploying_workflows.py
@@ -126,19 +126,19 @@
 
 .. code-block::
 
-   flyte-cli register-files -p flytetester -d development -v ${VERSION} --kubernetes-service-account demo \
-       --output-location-prefix s3://my-s3-bucket/raw_data -h flyte.example.com _pb_output/*
+   flytectl register files _pb_output/* -p flytetester -d development --version ${VERSION}  \
+       --k8sServiceAccount demo --outputLocationPrefix s3://my-s3-bucket/raw_data
 
 
 Of interest are the following args:
 
 - :code:`-p` specifies the project to register your entities. This project itself must already be registered on your Flyte deployment.
 - :code:`-d` specifies the domain to register your entities. This domain must already be configured in your Flyte deployment
-- :code:`-v` is a unique string used to identify this version of entities registered under a project and domain.
-- If required, you can specify a :code:`kubernetes-service-account` or :code:`assumable_iam_role` which your tasks will run with.
+- :code:`--version` is a unique string used to identify the version of your entities to be registered under a project and domain.
+- If required, you can specify a :code:`--k8sServiceAccount` and :code:`--assumableIamRole` which your tasks will run with.
 
 
-Fast(er) iteration
+Fast Registration
 ^^^^^^^^^^^^^^^^^^
 Re-building a new Docker container image for every code change you make can become cumbersome and slow.
 If you're making purely code changes that **do not** require updating your container definition, you can make use of
@@ -149,7 +149,7 @@
 
 .. code-block::
 
-   make fast_serialize
+   pyflyte --pkgs core package --image core:v1 --fast --force
 
 And then the fast register target:
 
@@ -161,8 +161,8 @@
 
 As fast registration serializes code from your local workstation and uploads it to the hosted flyte deployment, make sure to specify the following arguments correctly to ensure that the changes are picked up when the workflow is run.
 
-- :code:`pyflyte serialize` has a :code:`--local-source-root` option which specifies which code is uploaded during the fast registration step. This ensures that the files you want to modify are serialized. This is optional and should be used when your code lies outside of your current working directory.
-- :code:`flyte-cli fast-register-files` has a :code:`--dest-dir` option which specifies which folder (in the container) the fast serialization will dump the code in at execution time. This ensures that the running workflow loads the code changes that were uploaded via :code:`fast registration`.
+- :code:`pyflyte` has a flag :code:`--pkgs` that specifies the code to be packaged. The `fast` flag picks up the code from the local machine and provides it for execution without building and pushing a container.
+- :code:`pyflyte` also has a flag  :code:`--image` to specify the Docker image that has already been built.
 
 
 Building Images

diff --git a/cookbook/deployment/fast_registration.py b/cookbook/deployment/fast_registration.py
diff --git a/cookbook/docs/README.md b/cookbook/docs/README.md
@@ -26,6 +26,6 @@ To make this work, it is essential that the examples are written with comments f
    ```rst
     .. prompt::bash
 
-       flyte-cli test
+       flytectl --version
    ```
 
diff --git a/cookbook/docs/conf.py b/cookbook/docs/conf.py
@@ -85,7 +85,6 @@ class CustomSorter(FileNameSortKey):
         "deploying_workflows.py",
         "customizing_resources.py",
         "lp_notifications.py",
-        "fast_registration.py",
         "multiple_k8s.py",
         ## Cluster
         "config_flyte_deploy.py",