From 71ceba4ac588efcd995e2ffcdd9a5aea5f014371 Mon Sep 17 00:00:00 2001 From: Olliver Schinagl Date: Mon, 26 Nov 2018 15:49:23 +0100 Subject: [PATCH] type: Add new type __ping When starting with cdist, the documentation and examples can be overwheliming. Further more, sometimes one would only want to do a simple test to see if the basics are working. One such example currently is to create a simple remote file. While this is a nice and simple example, an even simpler example would be to just see if we can 'ping' the host. Other configuration management tools also seem to have this as a basic starting command. This thus allows to do: echo __ping | cdist config --initial-manifest - as the most basic, most simple command to 'test' things with, without having lingering files to boot. Signed-off-by: Olliver Schinagl --- cdist/conf/type/__ping/gencode-remote | 12 ++++++++ cdist/conf/type/__ping/man.rst | 43 +++++++++++++++++++++++++++ cdist/conf/type/__ping/singleton | 0 3 files changed, 55 insertions(+) create mode 100644 cdist/conf/type/__ping/gencode-remote create mode 100644 cdist/conf/type/__ping/man.rst create mode 100644 cdist/conf/type/__ping/singleton diff --git a/cdist/conf/type/__ping/gencode-remote b/cdist/conf/type/__ping/gencode-remote new file mode 100644 index 00000000..1341b954 --- /dev/null +++ b/cdist/conf/type/__ping/gencode-remote @@ -0,0 +1,12 @@ +#!/bin/sh -e +# +# Copyright (C) 2018 Olliver Schinagl +# +# SPDX-License-Identifier: GPL-3.0+ +# + +set -eu + +echo "echo 'pong'" + +exit 0 diff --git a/cdist/conf/type/__ping/man.rst b/cdist/conf/type/__ping/man.rst new file mode 100644 index 00000000..e08643dc --- /dev/null +++ b/cdist/conf/type/__ping/man.rst @@ -0,0 +1,43 @@ +cdist-type__ping(7) +================================== + +NAME +---- +cdist-type__ping - Try to connect to host and return 'pong' on success + + +DESCRIPTION +----------- +A simple type which tries to connect to a remote host and runs a simple command +to ensure everything is working. + + +REQUIRED PARAMETERS +------------------- +None. + + +OPTIONAL PARAMETERS +------------------- +None. + + +EXAMPLES +-------- + +.. code-block:: sh + + __ping + + +AUTHORS +------- +Olliver Schinagl + + +COPYING +------- +Copyright \(C) 2018 Schinagl. You can redistribute it +and/or modify it under the terms of the GNU General Public License as +published by the Free Software Foundation, either version 3 of the +License, or (at your option) any later version. diff --git a/cdist/conf/type/__ping/singleton b/cdist/conf/type/__ping/singleton new file mode 100644 index 00000000..e69de29b