github.com/Racer159/jackal@v0.32.7-0.20240401174413-0bd2339e4f2e/examples/yolo/README.md (about)

     1  import ExampleYAML from "@site/src/components/ExampleYAML";
     2  
     3  # YOLO Mode
     4  
     5  This example demonstrates YOLO mode, an optional mode for using Jackal in a fully connected environment where users can bring their own external container registry and Git server.
     6  
     7  ## Prerequisites
     8  
     9  - A running K8s cluster.
    10  
    11  :::note
    12  
    13  The cluster does not need to have the Jackal init package installed or any other Jackal-related bootstrapping.
    14  
    15  :::
    16  
    17  ## Instructions
    18  
    19  Create the package:
    20  
    21  ```bash
    22  jackal package create
    23  ```
    24  
    25  ### Deploy the package
    26  
    27  ```bash
    28  # Run the following command to deploy the created package to the cluster
    29  jackal package deploy
    30  
    31  # Choose the yolo package from the list
    32  ? Choose or type the package file [tab for suggestions]
    33  > jackal-package-yolo-<ARCH>.tar.zst
    34  
    35  # Confirm the deployment
    36  ? Deploy this Jackal package? (y/N)
    37  
    38  # Wait a few seconds for the cluster to deploy the package; you should
    39  # see the following output when the package has been finished deploying:
    40    Connect Command    | Description
    41    jackal connect doom  | Play doom!!!
    42    jackal connect games | Play some old dos games 🦄
    43  
    44  # Run the specified `jackal connect <game>` command to connect to the deployed
    45  # workload (ie. kill some demons). Note that the typical Jackal registry,
    46  # Gitea server and Jackal agent pods are not present in the cluster. This means
    47  # that the game's container image was pulled directly from the public registry and the URL was not mutated by Jackal.
    48  ```
    49  
    50  ## `jackal.yaml` {#jackal.yaml}
    51  
    52  :::info
    53  
    54  To view the example in its entirety, select the `Edit this page` link below the article and select the parent folder.
    55  
    56  :::
    57  
    58  <ExampleYAML src={require('./jackal.yaml')} showLink={false} />