From 55185af6371b949f70e694e206fb16e9ccc6abda Mon Sep 17 00:00:00 2001 From: Beni Cherniavsky-Paskin Date: Sun, 8 Apr 2018 12:49:42 +0300 Subject: [PATCH] README: say this gem is unmaintained, transition tips --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/README.md b/README.md index 951f61d..3335346 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,32 @@ # OpenshiftClient +## Deprecated — now covered by [Kubeclient](https://github.com/abonas/kubeclient) + +This gem is no longer being developed. It is not compatible, but also not necessary, with kubeclient 2.0.0 or later. + +### Transition tips (valid as of kubeclient 2.x – 4.2) + +Kubeclient gem since 2.0.0 is [capable of API discovery](https://github.com/abonas/kubeclient/pull/185) on any api extensions, including openshift. Simply construct a additional client with `/oapi` url: +``` +kclient = Kubeclient::Client.new('https://localhost:8443/api') +kclient.get_pods + +oclient = Kubeclient::Client.new('https://localhost:8443/oapi') +oclient.get_routes +``` + +Since openshift 3.6, instead of `oapi` you MAY also access all openshift entities under separate api groups at standard apis/ path, for example: +``` +template_client = Kubeclient::Client.new('https://localhost:8443/apis/template.openshift.io', 'v1') +template_client.get_templates +``` +(but this currently requires many more separate client objects) + +Don't use resource-specific classes such as `Kubeclient::Service` or `OpenshiftClient::Route`, just use `Kubeclient::Resource` for everything. + +See also [Kubeclient's changelog](https://github.com/abonas/kubeclient/blob/master/CHANGELOG.md). + +---- [![Gem Version](https://badge.fury.io/rb/openshift_client.svg)](http://badge.fury.io/rb/openshift_client) [![Build Status](https://travis-ci.org/abonas/openshift_client.svg?branch=master)](https://travis-ci.org/abonas/openshift_client)