github.com/Racer159/jackal@v0.32.7-0.20240401174413-0bd2339e4f2e/docs/3-create-a-jackal-package/10-dev.md (about)

     1  # Developing Jackal Packages
     2  
     3  ## `dev` Commands
     4  
     5  Jackal contains many commands that are useful while developing a Jackal package to iterate on configuration, discover resources and more!  Below are explanations of some of these commands with the full list discoverable with `jackal dev --help`.
     6  
     7  :::caution
     8  
     9  The `dev` commands are meant to be used in **development** environments / workflows. They are **not** meant to be used in **production** environments / workflows.
    10  
    11  :::
    12  
    13  ### `dev deploy`
    14  
    15  The `dev deploy` command will combine the lifecycle of `package create` and `package deploy` into a single command. This command will:
    16  
    17  - Not result in a re-usable tarball / OCI artifact
    18  - Not have any interactive prompts
    19  - Not require `jackal init` to be run (by default, but _is required_ if `--no-yolo` is not set)
    20  - Be able to create+deploy a package in either YOLO mode (default) or prod mode (exposed via `--no-yolo` flag)
    21  - Only build + deploy components that _will_ be deployed (contrasting with `package create` which builds _all_ components regardless of whether they will be deployed)
    22  
    23  ```bash
    24  # Create and deploy dos-games in yolo mode
    25  $ jackal dev deploy examples/dos-games
    26  ```
    27  
    28  ```bash
    29  # If deploying a package in prod mode, `jackal init` must be run first
    30  $ jackal init --confirm
    31  # Create and deploy dos-games in prod mode
    32  $ jackal dev deploy examples/dos-games --no-yolo
    33  ```
    34  
    35  ### `dev find-images`
    36  
    37  Evaluates components in a `jackal.yaml` to identify images specified in their helm charts and manifests.
    38  
    39  Components that have `git` repositories that host helm charts can be processed by providing the `--repo-chart-path`.
    40  
    41  ```bash
    42  $ jackal dev find-images examples/wordpress
    43  
    44  components:
    45  
    46    - name: wordpress
    47      images:
    48        - docker.io/bitnami/apache-exporter:0.13.3-debian-11-r2
    49        - docker.io/bitnami/mariadb:10.11.2-debian-11-r21
    50        - docker.io/bitnami/wordpress:6.2.0-debian-11-r18
    51  ```
    52  
    53  ### Misc `dev` Commands
    54  
    55  Not all `dev` commands have been mentioned here.
    56  
    57  Further `dev` commands can be discovered by running `jackal dev --help`.