summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKim Hagen <kim.sidney@gmail.com>2018-07-02 12:37:22 +0200
committerKim Hagen <kim.sidney@gmail.com>2018-07-02 12:37:22 +0200
commitc881147196e826a760836eaad7c9099d0879b485 (patch)
tree3743057cfc6b7f662f17a3b656d2c604010e919f
parentb5620c89d236365e53c0f78abfbe726cb03aaca4 (diff)
downloadvyos-salt-minion-c881147196e826a760836eaad7c9099d0879b485.tar.gz
vyos-salt-minion-c881147196e826a760836eaad7c9099d0879b485.zip
update readme and remove node
-rw-r--r--Makefile3
-rw-r--r--README.md57
2 files changed, 4 insertions, 56 deletions
diff --git a/Makefile b/Makefile
index 0501b14..325c11c 100644
--- a/Makefile
+++ b/Makefile
@@ -7,6 +7,9 @@ interface_definitions:
mkdir -p $(TMPL_DIR)
find $(CURDIR)/interface-definitions/ -type f | xargs -I {} $(CURDIR)/scripts/build-command-templates {} $(CURDIR)/schema/interface_definition.rng $(TMPL_DIR) || exit 1
+
+ # XXX: delete top level node.def's that now live in other packages
+ rm -f $(TMPL_DIR)/service/node.def
.PHONY: op_mode_definitions
.ONESHELL:
diff --git a/README.md b/README.md
index 665512c..ca63bc4 100644
--- a/README.md
+++ b/README.md
@@ -1,56 +1 @@
-# vyos-1x: VyOS 1.2.0+ configuration scripts and data
-
-[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=vyos%3Avyos-1x&metric=coverage)](https://sonarcloud.io/component_measures?id=vyos%3Avyos-1x&metric=coverage)
-
-VyOS 1.1.x had its codebase split into way too many submodules for no good reason, which made it hard
-to navigate or write meaningful changelogs. As the code undergoes rewrite in the new style in VyOS 1.2.0+,
-we consolidate the rewritten code in this package.
-
-If you just want to build a VyOS image, the repository you want is [vyos-build](https://github.com/vyos/vyos-build).
-If you also want to contribute to VyOS, read on.
-
-## Package layout
-
-```
-interface-definitions # Configuration interface (i.e. conf mode command) definitions
-op-mode-definitions # Operational command definitions
-src
- conf_mode/ # Configuration mode scripts
- op_mode/ # Operational mode scripts
- completion/ # Completion helpers
- validators/ # Value validators
- helpers/ # Misc helpers
- migration-scripts # Migration scripts
- tests/ # Unit tests
-
-python/ # Python modules
-
-scripts/ # Build-time scripts
-schema/ # XML schemas
-```
-
-## Interface/command definitions
-
-Raw node.def files for the old backend are no longer written by hand or generated by custom sciprts.
-They are all now produced from a unified XML format that supports a strict subset of the old backend
-features. In particular, it intentionally does not support embedded shell scripts, default values,
-and value "types", instead delegating those tasks to external scripts.
-
-Configuration interface definitions must conform to the schema found in schema/interface_definition.rng
-and operational command definitions must conform to schema/op-mode-definition.rng
-Schema checks are performed at build time, so a package with malformed interface definitions will not build.
-
-## Configuration scripts
-
-The guidelines in a nutshell:
-
-* Use separate functions for retrieving configuration data, validating it, and generating taret config
-* Use a template processor when the format is more complex than just one line (jinja2 and pystache are acceptable options)
-
-## Tests
-
-Tests are executed at build time, you can also execute them by hand with:
-
-```
-make test
-```
+# vyos-salt-minion