diff --git a/docs/source/index.rst b/docs/source/index.rst index 0445ec92..93ccc966 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -21,29 +21,31 @@ Installation Flytectl is a Golang binary that can be installed on any platform supported by Golang. -.. tabbed:: OSX +.. tab-set:: - .. prompt:: bash $ + .. tab-item:: OSX - brew install flyteorg/homebrew-tap/flytectl + .. prompt:: bash $ - *Upgrade* existing installation using the following command: + brew install flyteorg/homebrew-tap/flytectl - .. prompt:: bash $ + *Upgrade* existing installation using the following command: - flytectl upgrade + .. prompt:: bash $ -.. tabbed:: Other Operating systems + flytectl upgrade - .. prompt:: bash $ + .. tab-item:: Other Operating systems - curl -sL https://ctl.flyte.org/install | bash + .. prompt:: bash $ - *Upgrade* existing installation using the following command: + curl -sL https://ctl.flyte.org/install | bash - .. prompt:: bash $ + *Upgrade* existing installation using the following command: - flytectl upgrade + .. prompt:: bash $ + + flytectl upgrade **Test** if Flytectl is installed correctly (your Flytectl version should be > 0.2.0) using the following command: @@ -66,50 +68,52 @@ The full list of available configurable options can be found by running ``flytec Currently, the Project ``-p``, Domain ``-d``, and Output ``-o`` flags cannot be used in the config file. -.. tabbed:: Local Flyte Sandbox +.. tab-set:: + + .. tab-item:: Local Flyte Sandbox + + Automatically configured for you by ``flytectl sandbox`` command. - Automatically configured for you by ``flytectl sandbox`` command. + .. code-block:: yaml - .. code-block:: yaml + admin: + # For GRPC endpoints you might want to use dns:///flyte.myexample.com + endpoint: dns:///localhost:30081 + insecure: true # Set to false to enable TLS/SSL connection (not recommended except on local sandbox deployment). + authType: Pkce # authType: Pkce # if using authentication or just drop this. - admin: - # For GRPC endpoints you might want to use dns:///flyte.myexample.com - endpoint: dns:///localhost:30081 - insecure: true # Set to false to enable TLS/SSL connection (not recommended except on local sandbox deployment). - authType: Pkce # authType: Pkce # if using authentication or just drop this. + .. tab-item:: AWS Configuration -.. tabbed:: AWS Configuration + .. code-block:: yaml - .. code-block:: yaml + admin: + # For GRPC endpoints you might want to use dns:///flyte.myexample.com + endpoint: dns:/// + authType: Pkce # authType: Pkce # if using authentication or just drop this. + insecure: true # insecure: True # Set to true if the endpoint isn't accessible through TLS/SSL connection (not recommended except on local sandbox deployment) - admin: - # For GRPC endpoints you might want to use dns:///flyte.myexample.com - endpoint: dns:/// - authType: Pkce # authType: Pkce # if using authentication or just drop this. - insecure: true # insecure: True # Set to true if the endpoint isn't accessible through TLS/SSL connection (not recommended except on local sandbox deployment) + .. tab-item:: GCS Configuration -.. tabbed:: GCS Configuration + .. code-block:: yaml - .. code-block:: yaml + admin: + # For GRPC endpoints you might want to use dns:///flyte.myexample.com + endpoint: dns:/// + authType: Pkce # authType: Pkce # if using authentication or just drop this. + insecure: false # insecure: True # Set to true if the endpoint isn't accessible through TLS/SSL connection (not recommended except on local sandbox deployment) - admin: - # For GRPC endpoints you might want to use dns:///flyte.myexample.com - endpoint: dns:/// - authType: Pkce # authType: Pkce # if using authentication or just drop this. - insecure: false # insecure: True # Set to true if the endpoint isn't accessible through TLS/SSL connection (not recommended except on local sandbox deployment) + .. tab-item:: Others -.. tabbed:: Others + For other supported storage backends like Oracle, Azure, etc., refer to the configuration structure `here `__. - For other supported storage backends like Oracle, Azure, etc., refer to the configuration structure `here `__. + Place the config file in ``$HOME/.flyte`` directory with the name config.yaml. + This file is typically searched in: - Place the config file in ``$HOME/.flyte`` directory with the name config.yaml. - This file is typically searched in: + * ``$HOME/.flyte`` + * currDir from where you run flytectl + * ``/etc/flyte/config`` - * ``$HOME/.flyte`` - * currDir from where you run flytectl - * ``/etc/flyte/config`` - - You can also pass the file name in the command line using ``--config ``. + You can also pass the file name in the command line using ``--config ``. .. toctree:: diff --git a/docs/source/overview.rst b/docs/source/overview.rst index 08bb11a0..aac4c99e 100644 --- a/docs/source/overview.rst +++ b/docs/source/overview.rst @@ -14,29 +14,31 @@ Installation Flytectl is a Golang binary that can be installed on any platform supported by Golang. -.. tabbed:: OSX +.. tab-set:: - .. prompt:: bash $ + .. tab-item:: OSX - brew install flyteorg/homebrew-tap/flytectl + .. prompt:: bash $ - *Upgrade* existing installation using the following command: + brew install flyteorg/homebrew-tap/flytectl - .. prompt:: bash $ + *Upgrade* existing installation using the following command: - flytectl upgrade + .. prompt:: bash $ -.. tabbed:: Other Operating systems + flytectl upgrade - .. prompt:: bash $ + .. tab-item:: Other Operating systems - curl -sL https://ctl.flyte.org/install | bash + .. prompt:: bash $ - *Upgrade* existing installation using the following command: + curl -sL https://ctl.flyte.org/install | bash - .. prompt:: bash $ + *Upgrade* existing installation using the following command: - flytectl upgrade + .. prompt:: bash $ + + flytectl upgrade **Test** if Flytectl is installed correctly (your Flytectl version should be > 0.2.0) using the following command: @@ -59,47 +61,49 @@ The full list of available configurable options can be found by running ``flytec Currently, the Project ``-p``, Domain ``-d``, and Output ``-o`` flags cannot be used in the config file. -.. tabbed:: Local Flyte Sandbox +.. tab-set:: + + .. tab-item:: Local Flyte Sandbox + + Automatically configured for you by ``flytectl sandbox`` command. - Automatically configured for you by ``flytectl sandbox`` command. + .. code-block:: yaml - .. code-block:: yaml + admin: + # For GRPC endpoints you might want to use dns:///flyte.myexample.com + endpoint: dns:///localhost:30081 + insecure: true # Set to false to enable TLS/SSL connection (not recommended except on local sandbox deployment). + authType: Pkce # authType: Pkce # if using authentication or just drop this. - admin: - # For GRPC endpoints you might want to use dns:///flyte.myexample.com - endpoint: dns:///localhost:30081 - insecure: true # Set to false to enable TLS/SSL connection (not recommended except on local sandbox deployment). - authType: Pkce # authType: Pkce # if using authentication or just drop this. + .. tab-item:: AWS Configuration -.. tabbed:: AWS Configuration + .. code-block:: yaml - .. code-block:: yaml + admin: + # For GRPC endpoints you might want to use dns:///flyte.myexample.com + endpoint: dns:/// + authType: Pkce # authType: Pkce # if using authentication or just drop this. + insecure: true # insecure: True # Set to true if the endpoint isn't accessible through TLS/SSL connection (not recommended except on local sandbox deployment) - admin: - # For GRPC endpoints you might want to use dns:///flyte.myexample.com - endpoint: dns:/// - authType: Pkce # authType: Pkce # if using authentication or just drop this. - insecure: true # insecure: True # Set to true if the endpoint isn't accessible through TLS/SSL connection (not recommended except on local sandbox deployment) + .. tab-item:: GCS Configuration -.. tabbed:: GCS Configuration + .. code-block:: yaml - .. code-block:: yaml + admin: + # For GRPC endpoints you might want to use dns:///flyte.myexample.com + endpoint: dns:/// + authType: Pkce # authType: Pkce # if using authentication or just drop this. + insecure: false # insecure: True # Set to true if the endpoint isn't accessible through TLS/SSL connection (not recommended except on local sandbox deployment) - admin: - # For GRPC endpoints you might want to use dns:///flyte.myexample.com - endpoint: dns:/// - authType: Pkce # authType: Pkce # if using authentication or just drop this. - insecure: false # insecure: True # Set to true if the endpoint isn't accessible through TLS/SSL connection (not recommended except on local sandbox deployment) + .. tab-item:: Others -.. tabbed:: Others + For other supported storage backends like Oracle, Azure, etc., refer to the configuration structure `here `__. - For other supported storage backends like Oracle, Azure, etc., refer to the configuration structure `here `__. + Place the config file in ``$HOME/.flyte`` directory with the name config.yaml. + This file is typically searched in: - Place the config file in ``$HOME/.flyte`` directory with the name config.yaml. - This file is typically searched in: + * ``$HOME/.flyte`` + * currDir from where you run flytectl + * ``/etc/flyte/config`` - * ``$HOME/.flyte`` - * currDir from where you run flytectl - * ``/etc/flyte/config`` - - You can also pass the file name in the command line using ``--config ``. + You can also pass the file name in the command line using ``--config ``.