M type/__evilham_woodpecker_ci_agent/man.rst => type/__evilham_woodpecker_ci_agent/man.rst +26 -38
@@ 1,64 1,52 @@
-cdist-type__evilham_victoriametrics(7)
+cdist-type__evilham_woodpecker_ci_agent(7)
===================================
NAME
----
-cdist-type__evilham_victoriametrics - Setup a victoriametrics service
+cdist-type__evilham_woodpecker_ci_agent - Setup a woodpercker-agent service
DESCRIPTION
-----------
-VictoriaMetrics is a monitoring software solution and time-series database,
-written in go. It can provide long-term storage for Prometheus.
-
-The object identification given to the type will be the subfolder use for the
-data storage inside the home directory for the user. This allows for multiple
-node instances in the same victoria metrics service.
+Woodpecker is an open source CI engine that uses docker to run pipelines. It
+offers flexibility and extensibility.
OPTIONAL PARAMETERS
-------------------
user
User that owns the victoria metrics data directory.
- Defaults to `victoriametrics`.
-
-data-path
- Alternative path for the storage of victoria metrics.
- Defaults to `/var/lib/victoria-metrics-data`.
+ Defaults to `woodpecker`.
-retention-period
- Alternative retention period for the data storage in storage-data-path.
- It accepts a number follow by the unit; h(hours), d(days), w(weeks),
- y(years). If the unit isn't specified, months is the default.
- Defaults to 1 month.
-
-listen-address
- Address and port to listen to TCP connections.
- Defaults to `:8428`.
+work-dir
+ Alternative path for the storage of Woodpecker.
+ Defaults to `/var/lib/woodpecker-agent`.
extra-args
- Extra arguments for configurating flags on victoria metrics.
+ Extra arguments for configurating enviroment variables in
+ woodpecker-server. This is the main way of setting up woodpecker. If it's
+ unused, the service will assing the default values of configuration.
+ We recommend reading the woodpecker-ci documentation before starting.
EXAMPLES
--------
.. code-block:: sh
- # Setup Victoria Metrics instances
- __evilham_victoriametrics vm0 \
- --retention-period 5y --listen-address '[::1]:8420'
- __evilham_victoriametrics vm1 \
- --retention-period 5y --listen-address '[::1]:8421' \
- --extra-args '-relabelConfig /var/lib/vm-data/vm1.relabel.yml'
- require="__evilham_victoriametrics/vm0\
- __file '/var/lib/vm-data/vm0.relabel.yml'\
- --mode 0444 \
- --source - <<EOF
-# Drop environment label
-- action: labeldrop
- regex: 'environment'
-EOF
-"
+ # Setup woodpecker-server service
+ __evilham_woodpecker_ci_agent agent1\
+ --extra-args "$(cat << DONE
+export WOODPECKER_SERVER=woodpecker-ci.example.org:9000
+export WOODPECKER_AGENT_SECRET=${AGENT_SECRET}
+export WOODPECKER_BACKEND=docker
+export WOODPECKER_LOG_LEVEL=trace
+
+DONE
+)"
+SEE ALSO
+--------
+- `__evilham_woodpecker_ci_server(7)`
+- `https://woodpecker-ci.org/docs/administration/agent-config`
AUTHORS
-------
M type/__evilham_woodpecker_ci_agent/manifest => type/__evilham_woodpecker_ci_agent/manifest +1 -1
@@ 28,7 28,7 @@ __evilham_single_binary_service "${__object_id}"\
--checksum "${CHECKSUM}" \
--url "${DOWNLOAD_URL}" \
--working-directory "${WORK_DIR}" \
- --user-home-dir "${WORK_DIR}" \
+ --user-home-dir "${DATA_PATH}" \
--state "present" \
--unpack \
--unpack-extension ".tar.gz" \
M type/__evilham_woodpecker_ci_server/man.rst => type/__evilham_woodpecker_ci_server/man.rst +33 -38
@@ 1,64 1,59 @@
-cdist-type__evilham_victoriametrics(7)
+cdist-type__evilham_woodpecker_ci_server(7)
===================================
NAME
----
-cdist-type__evilham_victoriametrics - Setup a victoriametrics service
+cdist-type__evilham_woodpecker_ci_server - Setup a woodpercker-server service
DESCRIPTION
-----------
-VictoriaMetrics is a monitoring software solution and time-series database,
-written in go. It can provide long-term storage for Prometheus.
-
-The object identification given to the type will be the subfolder use for the
-data storage inside the home directory for the user. This allows for multiple
-node instances in the same victoria metrics service.
+Woodpecker is an open source CI engine that uses docker to run pipelines. It
+offers flexibility and extensibility.
OPTIONAL PARAMETERS
-------------------
user
User that owns the victoria metrics data directory.
- Defaults to `victoriametrics`.
-
-data-path
- Alternative path for the storage of victoria metrics.
- Defaults to `/var/lib/victoria-metrics-data`.
+ Defaults to `woodpecker`.
-retention-period
- Alternative retention period for the data storage in storage-data-path.
- It accepts a number follow by the unit; h(hours), d(days), w(weeks),
- y(years). If the unit isn't specified, months is the default.
- Defaults to 1 month.
-
-listen-address
- Address and port to listen to TCP connections.
- Defaults to `:8428`.
+work-dir
+ Alternative path for the storage of Woodpecker.
+ Defaults to `/var/lib/woodpecker-server`.
extra-args
- Extra arguments for configurating flags on victoria metrics.
+ Extra arguments for configurating enviroment variables in
+ woodpecker-server. This is the main way of setting up woodpecker. If it's
+ unused, the service will assing the default values of configuration.
+ We recommend reading the woodpecker-ci documentation before starting.
EXAMPLES
--------
.. code-block:: sh
- # Setup Victoria Metrics instances
- __evilham_victoriametrics vm0 \
- --retention-period 5y --listen-address '[::1]:8420'
- __evilham_victoriametrics vm1 \
- --retention-period 5y --listen-address '[::1]:8421' \
- --extra-args '-relabelConfig /var/lib/vm-data/vm1.relabel.yml'
- require="__evilham_victoriametrics/vm0\
- __file '/var/lib/vm-data/vm0.relabel.yml'\
- --mode 0444 \
- --source - <<EOF
-# Drop environment label
-- action: labeldrop
- regex: 'environment'
-EOF
-"
+ # Setup woodpecker-server service
+ __evilham_woodpecker_ci_server --extra-args "$(cat << DONE
+export WOODPECKER_HOST=https://woodpecker-ci.example.org
+export WOODPECKER_OPEN=true
+export WOODPECKER_AGENT_SECRET=61c11e52146af3cf36d767eabb01971fd051f4d0da2320
+export WOODPECKER_LOG_LEVEL=trace
+
+export WOODPECKER_GITEA=true
+export WOODPECKER_GITEA_URL=https://forgejo.example.org
+export WOODPECKER_GITEA_CLIENT=9317652ea492c5b278b4e9c91cfd37
+export WOODPECKER_GITEA_SECRET=4460d95b8a4852cbdba5c5776a0e678147c67086441c1
+
+export WOODPECKER_DATABASE_DRIVER=postgres
+export WOODPECKER_DATABASE_DATASOURCE=postgresql://wp@postgresql.exa:5432/wpdb
+DONE
+)"
+
+SEE ALSO
+--------
+- `__evilham_woodpecker_ci_agent(7)`
+- `https://woodpecker-ci.org/docs/administration/server-config`
AUTHORS
-------