README

OpenShift 在 Kubernetes 的基础上提供构建、应用程序生命周期、镜像内容管理以及管理策略。该 API 允许对这些对象进行一致管理。所有 API 操作都通过授权令牌进行认证，该令牌作为服务账户的生成密钥（JWT 格式）或通过位于 /oauth/authorize 的本地 OAuth 端点提供。核心基础设施组件可能使用不需要认证的客户端证书。所有 API 操作都返回一个 'resourceVersion' 字符串，表示底层存储中对象的版本。标准的 LIST 操作对底层对象执行快照读取，返回一个表示所列对象一致版本的 resourceVersion。WATCH 操作允许客户端观察在提供的 resourceVersion 之后对一组对象的任何更新。通过从返回的资源版本开始列表和监视，客户端可以观察到一个或多个对象状态的持续视图。请注意，WATCH 总是返回提供资源版本之后的更新。监视可以扩展到过去的一定时间范围内 - 使用 etcd 2 时，监视窗口为 1000 个事件（在大型集群中可能仅为几秒钟），因此客户端必须明确处理“监视过旧错误”通过重新列出。对象被分为两大类 - 那些具有生命周期并必须反映集群状态的对象，以及那些没有状态的对象。具有生命周期的对象通常有三个主要部分：* 'metadata'，对所有对象都通用 * 'spec'，表示所需状态 * 'status'，表示在当前时间有多少所需状态反映在集群上。没有状态的对象具有 'metadata'，但可能缺少 'spec' 或 'status' 部分。对象分为命名空间范围（仅存在于命名空间内）和集群范围（存在于命名空间外）。命名空间范围的资源在删除命名空间时将被删除，如果命名空间尚未创建或正在删除过程中，则不能创建。集群范围的资源通常仅对管理员可访问 - 例如节点、持久卷和集群策略等资源。所有对象都具有一个由 'kind' 和 'apiVersion' 字段组合而成的模式。此模式仅对任何给定版本是累加的 - 不允许在不增加 apiVersion 的情况下进行向后不兼容的更改。服务器将返回并接受一系列标准响应，这些响应具有一个共同的模式 - 例如，常见的错误类型是 'metav1.Status'（下面将描述）并在 API 服务器上的任何错误时返回。API 可用多种序列化格式 - 默认为 JSON（Accept: application/json 和 Content-Type: application/json），但客户端也可以使用 YAML（application/yaml）或本地的 Protobuf 模式（application/vnd.kubernetes.protobuf）。请注意，WATCH API 调用的格式略有不同 - 对于 JSON，它返回换行符分隔的对象，而对于 Protobuf，它返回长度分隔的帧（4 字节网络顺序），其中包含一个 'versioned.Watch' Protobuf 对象。有关更多信息，请参阅 OpenShift 文档：https://docs.openshift.org。

此 PHP 包是由 Swagger Codegen 项目自动生成的

API 版本：最新版
构建包：io.swagger.codegen.languages.PhpClientCodegen

要求

PHP 5.5 及以上版本

安装与使用

Composer

通过Composer安装绑定，请将以下内容添加到composer.json

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/universityofadelaide/openshift-restclient-php.git"
    }
  ],
  "require": {
    "universityofadelaide/openshift-restclient-php": "*@dev"
  }
}

然后运行composer install

手动安装

下载文件并包含autoload.php

    require_once('/path/to/openshift-restclient-php/vendor/autoload.php');

测试

要运行单元测试

composer install
./vendor/bin/phpunit

入门指南

请遵循安装程序，然后运行以下命令

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: openshift_auth
UniversityOfAdelaide\OpenShift\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new UniversityOfAdelaide\OpenShift\Api\ApisApi();

try {
    $result = $api_instance->getAPIVersions();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApisApi->getAPIVersions: ', $e->getMessage(), PHP_EOL;
}

?>

API端点文档

所有URI均相对于https://

模型文档

授权文档

openshift_auth

类型: OAuth
流程: 隐式
授权 URL: https:///oauth/authorize
作用域:
写入: openshift: 修改
读取: openshift: 读取

universityofadelaide / openshift-restclient-php

维护者

详细信息