github.com/replicatedhq/ship@v0.55.0/integration/init/factorio/expected/.ship/upstream/README.md (about)

     1  # Factorio
     2  
     3  [Factorio](https://www.factorio.com/) is a game in which you build and maintain factories.
     4  
     5  ## Introduction
     6  
     7  This chart creates a single [Factorio Headless](https://www.factorio.com/download-headless) Pod, plus Services for the Factorio server and RCON.
     8  
     9  ## Prerequisites
    10  
    11  - Kubernetes 1.4+ with Beta APIs enabled
    12  - PV provisioner support in the underlying infrastructure
    13  
    14  ## Provider-specific Prerequisites
    15  
    16  Amazon's Elastic Loadbalancer lacks support for UDP. You'll need to set `factorioServer.ServiceType` to `NodePort` and expose the port that gets selected (see `kubectl describe svc <servicename>`) via a security group. You may need to do something similar for certain bare metal deployments.
    17  
    18  You need not worry about this on Google Cloud Platform.
    19  
    20  ## Installing the Chart
    21  
    22  To install the chart with the release name `my-release`:
    23  
    24  ```bash
    25  $ helm install --name my-release stable/factorio
    26  ```
    27  
    28  This command deploys a Factorio dedicated server with sane defaults.
    29  
    30  > **Tip**: List all releases using `helm list`
    31  
    32  ## Uninstalling the Chart
    33  
    34  To uninstall/delete the `my-release` deployment:
    35  
    36  ```bash
    37  $ helm delete my-release
    38  ```
    39  
    40  The command removes all the Kubernetes components associated with the chart and deletes the release.
    41  
    42  ## Configuration
    43  
    44  Refer to [values.yaml](values.yaml) for the full run-down on defaults. These are a mixture of Kubernetes and Factorio-related directives that map to environment variables in [docker-factorio](https://github.com/games-on-k8s/docker-factorio).
    45  
    46  Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
    47  
    48  ```bash
    49  $ helm install --name my-release \
    50    --set factorioServer.factorioServer=My Server,ImageTag=0.14.15 \
    51      stable/factorio
    52  ```
    53  
    54  The above command deploys Factorio dedicated with a server name of `My Server` and docker-factorio image version `0.14.15`.
    55  
    56  Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example,
    57  
    58  ```bash
    59  $ helm install --name my-release -f values.yaml stable/factorio
    60  ```
    61  
    62  > **Tip**: You can use the default [values.yaml](values.yaml)
    63  
    64  ## Persistence
    65  
    66  The [docker-factorio](https://github.com/games-on-k8s/docker-factorio) image stores the saved games and mods under /opt/factorio.
    67  
    68  By default a PersistentVolumeClaim is created and mounted for saves but not mods. In order to disable this functionality
    69  you can change the values.yaml to disable persistence under the sub-sections under `Persistence`.
    70  
    71  > *"An emptyDir volume is first created when a Pod is assigned to a Node, and exists as long as that Pod is running on that node. When a Pod is removed from a node for any reason, the data in the emptyDir is deleted forever."*