Skip to content

Commit

Permalink
docs: Remove redundant dollar signs (#4964)
Browse files Browse the repository at this point in the history
Signed-off-by: Chi-Sheng Liu <[email protected]>
  • Loading branch information
MortalHappiness authored Mar 1, 2024
1 parent 2256c2b commit a946070
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 11 deletions.
16 changes: 8 additions & 8 deletions docs/community/troubleshoot.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Before getting started, collect the following information from the underlying in

.. prompt:: bash $

$ kubectl describe pod <PodName> -n <namespace>
kubectl describe pod <PodName> -n <namespace>

Where <PodName> will typically correspond to the node execution string that you can find in the UI.

Expand All @@ -23,7 +23,7 @@ Where <PodName> will typically correspond to the node execution string that you

.. prompt:: bash $

$ kubectl logs pods -n <namespace>
kubectl logs pods -n <namespace>

Where <namespace> will typically correspond to the Flyte <project>-<domain>, e.g. flytesnacks-development.

Expand Down Expand Up @@ -70,7 +70,7 @@ This issue is more common on MacOS devices. Make sure that your Docker daemon ha
.. prompt:: bash $
$ flytectl demo start --env HTTP_PROXY=<your-proxy-IP>
flytectl demo start --env HTTP_PROXY=<your-proxy-IP>
- If you're building a custom Docker image, make sure to use a tag other than ``latest``. Otherwise, the Kubernetes default pull policy will be changed from ``IfNotPresent`` to ``Always``, forcing an image pull with every Pod deployment.
Expand All @@ -85,14 +85,14 @@ Issues running workloads
.. prompt:: bash $
$ export FLYTECTL_CONFIG=~/.flyte/config-sandbox.yaml
export FLYTECTL_CONFIG=~/.flyte/config-sandbox.yaml
``ModuleNotFoundError``
^^^^^^^^^^^^^^^^^^^^^^^
- If you're using a custom container image and using Docker, make sure your ``Dockerfile`` is located at the same level of the ``flyte`` directory and that there is an empty ``__init__.py`` file in your project's folder :
.. prompt:: bash $
.. prompt::
myflyteapp
├── Dockerfile
Expand All @@ -111,11 +111,11 @@ Issues running workloads
.. prompt:: bash $
$ kubectl describe sa <my-flyte-sa> -n <flyte-namespace>
kubectl describe sa <my-flyte-sa> -n <flyte-namespace>
Example output:
.. prompt:: bash $
.. prompt::
Name: <my-flyte-sa>
Namespace: flyte
Expand All @@ -130,7 +130,7 @@ Example output:
.. prompt:: bash $
$ kubectl annotate serviceaccount -n <flyte-namespace> <http://eks.amazonaws.com/role-arn=arn:aws:iam::xxxx:role/<flyte-iam-role>eks.amazonaws.com/role-arn=arn:aws:iam::xxxx:role/<flyte-iam-role>
kubectl annotate serviceaccount -n <flyte-namespace> <http://eks.amazonaws.com/role-arn=arn:aws:iam::xxxx:role/<flyte-iam-role>eks.amazonaws.com/role-arn=arn:aws:iam::xxxx:role/<flyte-iam-role>
- Refer to this community-maintained `guides <https://github.com/davidmirror-ops/flyte-the-hard-way/blob/main/docs/03-roles-service-accounts.md>`_ for further information about Flyte deployment on EKS
Expand Down
9 changes: 6 additions & 3 deletions docs/deployment/deployment/multicluster.rst
Original file line number Diff line number Diff line change
Expand Up @@ -398,11 +398,14 @@ label has to be 1.
11. Verify that all Pods in the ``flyte`` namespace are ``Running``:
.. prompt:: bash $
kubectl get pods -n flyte
Example output:
.. prompt:: bash $
.. prompt::
kubectl get pods -n flyte
NAME READY STATUS RESTARTS AGE
datacatalog-86f6b9bf64-bp2cj 1/1 Running 0 23h
datacatalog-86f6b9bf64-fjzcp 1/1 Running 0 23h
Expand Down Expand Up @@ -658,4 +661,4 @@ The process can be repeated for additional clusters.
15. A successful execution should be visible on the UI, confirming it ran in the new cluster:
.. image:: https://raw.githubusercontent.com/flyteorg/static-resources/main/common/multicluster-execution.png
.. image:: https://raw.githubusercontent.com/flyteorg/static-resources/main/common/multicluster-execution.png

0 comments on commit a946070

Please sign in to comment.