Skip to content

Commit cb4f1a6

Browse files
author
Michael Sauter
authored
Document future direction
1 parent ce69d6a commit cb4f1a6

1 file changed

Lines changed: 12 additions & 7 deletions

File tree

README.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Tailor
22

3-
Tailor is a tool to drive the configuration of your OpenShift resources via
4-
templates under version control. Any drift between your desired state (the YAML templates) and the current state (resources in the cluster) can be detected, reviewed and reconciled using a CLI interface. Tailor is required by other OpenDevStack repositories, but is fully standalone and may be used in completely different contexts. It uses `oc` commands under the hood, and is based on
5-
plain OpenShift templates.
3+
Tailor is a tool to drive the configuration of your OpenShift resources via templates under version control. Any drift between your desired state (the YAML templates) and the current state (resources in the cluster) can be detected, reviewed and reconciled using a CLI interface. Tailor is required by other OpenDevStack repositories, but is fully standalone and may be used in completely different contexts. It uses `oc` commands under the hood, and is based on plain OpenShift templates.
4+
5+
The main target of Tailor is OpenShift 3.11. Tailor also works against OpenShift 4, but it is recommended to transition to other tools, such as Helm or kustomize, which have become popular and work well against OpenShift 4. If you are interested how Tailor compares to those tools, please see [comparison to other tools](https://github.com/opendevstack/tailor#comparison-to-other-tools).
66

77
## Benefits of using infrastructure-as-code
88

@@ -19,11 +19,9 @@ plain OpenShift templates.
1919
* Simple interface which avoids having to stitch multiple commands together and massage their output to achieve the desired result.
2020
* Options can be stored in a `Tailorfile` to ease invocation and ensure consistency within teams.
2121

22-
If you are interested how Tailor compares to other tools such as Helm, please see [comparison to other tools](https://github.com/opendevstack/tailor#comparison-to-other-tools).
23-
2422
## Installation
2523

26-
The latest release is 1.3.0 and requires oc >= v3.9.0. OpenShift 4 is not officially supported yet although 1.0.0 and above work in principle.
24+
The latest release is 1.3.0 and requires oc = v3.11. OpenShift 4 is not officially supported yet although 1.3.0 is known to work with OpenShift 4.6. Note that Tailor is now considered to be feature-complete and will only receive bug fixes going forward.
2725
Please have a look at the [changelog](https://github.com/opendevstack/tailor/blob/master/CHANGELOG.md) when upgrading.
2826

2927
MacOS:
@@ -146,9 +144,16 @@ eval "$(tailor --completion-script-$(echo $SHELL | awk -F/ '{print $NF}'))"
146144
* Compared to Helm v2, Tailor does not need a highly privileged Tiller. Helm v3 does not need it either.
147145
* Tailor works with plain OpenShift templates instead of Helm charts. OpenShift templates are simpler, and can easily be generated from existing resources in OpenShift.
148146
* Tailor has a narrower scope - it is basically an "`oc` on steroids". Helm has more extensive features like searching for charts etc.
149-
* Tailor targets OpenShift, Helm targets Kubernetes. Using Helm for OpenShift has limitations / bugs around dealing with OpenShift resources such as `BuildConfig` or `Route` (note those look fixed in [OpenShift 4.4](https://access.redhat.com/errata/RHBA-2020:0581)).
147+
* Tailor targets OpenShift, Helm targets Kubernetes. Using Helm for OpenShift 3.11 has limitations / bugs around dealing with OpenShift resources such as `BuildConfig` or `Route`. Note those are fixed in [OpenShift 4.4](https://access.redhat.com/errata/RHBA-2020:0581).
150148
* Tailor allows to check for drift, and allows to review the difference between live configuration and desired state before applying.
151149

150+
If you are a Tailor user wanting to migrate to Helm, check out the [migration guide](https://github.com/opendevstack/tailor/wiki/Migrating-from-Tailor-to-Helm).
151+
152+
### Tailor vs. kustomize
153+
* Tailor targets OpenShift, kustomize targets Kubernetes
154+
* Tailor uses a templating approach, kustomize uses patching
155+
* Tailor comes with its own drift/diff mechanism, whereas kustomize only focuses on specifying resources. However, newer versions of Kubernetes support `kubectl diff`, which can be used to view differences.
156+
152157
## FAQ / Troubleshooting
153158

154159
### Tailor does not recognize a certain resource kind

0 commit comments

Comments
 (0)