Genesis
=======

Specific configuration for the genesis process.  This document is a strict
superset of the combination of :doc:`kubernetes-node` and :doc:`host-system`,
so only differences are discussed here.


Sample Document
---------------

Here is a complete sample document:

.. code-block:: yaml

    schema: promenade/Genesis/v1
    metadata:
      schema: metadata/Document/v1
      name: genesis
      layeringDefinition:
        abstract: false
        layer: site
    data:
      hostname: n0
      ip: 192.168.77.10
      armada:
        target_manifest: cluster-bootstrap
        metrics:
          output_dir: /var/log/armada/metrics
          max_attempts: 5
      tiller:
        listen: 24134
        probe_listen: 24135
        storage: secret
      labels:
        static:
          - calico-etcd=enabled
          - node-role.kubernetes.io/master=
        dynamic:
          - kubernetes-apiserver=enabled
          - kubernetes-controller-manager=enabled
          - kubernetes-etcd=enabled
          - kubernetes-scheduler=enabled
          - promenade-genesis=enabled
          - ucp-control-plane=enabled
      images:
        armada: quay.io/airshipit/armada:latest
        helm:
          tiller: ghcr.io/helm/tiller:v2.17.0
        kubernetes:
          apiserver: k8s.gcr.io/kube-apiserver-amd64:v1.20.5
          controller-manager: k8s.gcr.io/kube-controller-manager-amd64:v1.20.5
          etcd: quay.io/coreos/etcd:v3.4.13
          scheduler: k8s.gcr.io/kube-scheduler-amd64:v1.20.5
      files:
        - path: /var/lib/anchor/calico-etcd-bootstrap
          content: ""
          mode: 0644


Armada
------

Configuration options for bootstrapping with Armada.

+-----------------+----------+---------------------------------------------------------------------------------------+
| keyword         | type     | action                                                                                |
+=================+==========+=======================================================================================+
| target_manifest | string   | Specifies the ``armada/Manifest/v1`` to use during Genesis.                           |
+-----------------+----------+---------------------------------------------------------------------------------------+
| metrics         | object   | See `Metrics`_.                                                                       |
+-----------------+----------+---------------------------------------------------------------------------------------+

Metrics
^^^^^^^

Configuration for Armada bootstrap metric collection.

+-----------------+----------+---------------------------------------------------------------------------------------+
| keyword         | type     | action                                                                                |
+=================+==========+=======================================================================================+
| output_dir      | string   | (optional, default `/var/log/node-exporter-textfiles`) The directory path in which to |
|                 |          | output Armada metric data.                                                            |
+-----------------+----------+---------------------------------------------------------------------------------------+
| max_attempts    | integer  | (optional, default 10) The maximum Armada attempts to collect metrics for.            |
|                 |          | Can be set to 0 to disable metrics collection.                                        |
+-----------------+----------+---------------------------------------------------------------------------------------+

Tiller
------

Configuration options for bootstrapping with Tiller.

+-----------------+----------+---------------------------------------------------------------------------------------+
| keyword         | type     | action                                                                                |
+=================+==========+=======================================================================================+
| storage         | string   | (optional, not passed by default) The tiller `storage`_ arg to use. `                 |
+-----------------+----------+---------------------------------------------------------------------------------------+
| listen          | integer  | (optional, default `24134`) The tiller `listen` arg to use. See `Ports`_.             |
+-----------------+----------+---------------------------------------------------------------------------------------+
| probe_listen    | integer  | (optional, default `24135`) The tiller `probe_listen` arg to use. See `Ports`_.       |
+-----------------+----------+---------------------------------------------------------------------------------------+

Ports
^^^^^

By default, promenade uses tiller ports outside of `net.ipv4.ip_local_port_range` to
avoid conflicts with apiserver connections to etcd, see `example`_.

The `listen` and `probe_listen` parameters allow setting these back to the
upstream tiller defaults (or any other value) if desired.

Bootstrapping Images
--------------------

Bootstrapping images are specified in the top level key ``images``:

.. code-block:: yaml

    armada: <Armada image for bootstrapping>
    helm:
      tiller: <Tiller image for bootstrapping>
    kubernetes:
      apiserver: <API server image for bootstrapping>
      controller-manager: <Controller Manager image for bootstrapping>
      etcd: <etcd image for bootstrapping>
      scheduler: <Scheduler image for bootstrapping>

.. _storage: https://helm.sh/docs/using_helm/#tiller-s-release-information
.. _example: https://helm.sh/docs/developing_charts/#chart-dependencies