引言
在构建基于 OpenShift 的应用时,会涉及到许多与 OpenShift API 相关的操作。@absa-subatomic/openshift-api 是一个非常好用的 npm 包,可以方便地对 OpenShift API 进行操作。在本篇文章中,我们将介绍如何使用 @absa-subatomic/openshift-api 这个 npm 包。
安装
使用 npm 进行安装:
--- ------- ----------------------------- ------
示例
在使用之前,我们先创建一个简单的示例来演示如何使用 @absa-subatomic/openshift-api 包。
----- ------------ - ----------------------------------------- ----- ------ - - ---- --------------------------- --------- ----------- --------- ----------- ---------- ---- -- ----- --- - --- --------------------- ----- --------- - ------------ -- ---- --- -------------------------- ------- ----- -- - -- ------- - --------------------- - ---- - ------------------ -- ------ --- -- - --- -- ---- ---------- ----- ---------- - - --------- - ----- -------- ---------- --------- -- ----- - --------- -- --------- - --------- - ------- - ---- ------- - -- ----- - ----------- - - ----- -------- ------ --------------- ------ - - -------------- -- - - - - - - - -- --------------------------------- ----------- ------- ------- -- - -- ------- - --------------------- - ---- - -------------------- -- ------ ---------- - ---
API 索引
@absa-subatomic/openshift-api 包提供了以下 API:
builds
configmaps
deployments
imagestreams
persistentvolumeclaims
pods
replicationcontrollers
routes
secrets
services
我们将分别介绍这些 API 的使用方法。
builds
builds
API 用于操作 build 相关的资源,包括 build configurations 和 build logs 等。
getAll(namespace, callback)
: 获取所有的 build resources。get(namespace, name, callback)
: 获取 name 指定的 build resource。instantiate(namespace, name, callback)
: 根据 name 创建并实例化一个 build 相关的资源。
configmaps
configmaps
API 用于操作 configmaps。
getAll(namespace, callback)
: 获取指定 namespace 中的所有 configmaps。create(namespace, configMap, callback)
: 在指定 namespace 中创建一个 configmap。get(namespace, name, callback)
: 获取指定 namespace 中指定名称的 configmap。update(namespace, name, configMap, callback)
: 更新指定 namespace 中指定名称的 configmap。delete(namespace, name, callback)
: 删除指定 namespace 中指定名称的 configmap。
deployments
deployments
API 用于操作 deployments。
getAll(namespace, callback)
: 获取指定 namespace 中的所有 deployment。create(namespace, deployment, callback)
: 在指定 namespace 中创建一个 deployment。get(namespace, name, callback)
: 获取指定 namespace 中指定名称的 deployment。update(namespace, name, deployment, callback)
: 更新指定 namespace 中指定名称的 deployment。delete(namespace, name, callback)
: 删除指定 namespace 中指定名称的 deployment。
imagestreams
imagestreams
API 用于操作 imagestreams。
getAll(namespace, callback)
: 获取指定 namespace 中的所有 imagestreams。create(namespace, imageStream, callback)
: 在指定 namespace 中创建一个 imagestream。get(namespace, name, callback)
: 获取指定 namespace 中指定名称的 imagestream。update(namespace, name, imageStream, callback)
: 更新指定 namespace 中指定名称的 imagestream。delete(namespace, name, callback)
: 删除指定 namespace 中指定名称的 imagestream。
persistentvolumeclaims
persistentvolumeclaims
API 用于操作 persistentvolumeclaims。
getAll(namespace, callback)
: 获取指定 namespace 中的所有 persistentvolumeclaims。create(namespace, persistentVolumeClaim, callback)
: 在指定 namespace 中创建一个 persistentvolumeclaim。get(namespace, name, callback)
: 获取指定 namespace 中指定名称的 persistentvolumeclaim。update(namespace, name, persistentVolumeClaim, callback)
: 更新指定 namespace 中指定名称的 persistentvolumeclaim。delete(namespace, name, callback)
: 删除指定 namespace 中指定名称的 persistentvolumeclaim。
pods
pods
API 用于操作 pods。
getAll(namespace, callback)
: 获取指定 namespace 中的所有 pod。get(namespace, name, callback)
: 获取指定 namespace 中指定名称的 pod。create(namespace, pod, callback)
: 在指定 namespace 中创建一个 pod。update(namespace, name, pod, callback)
: 更新指定 namespace 中指定名称的 pod。delete(namespace, name, callback)
: 删除指定 namespace 中指定名称的 pod。
replicationcontrollers
replicationcontrollers
API 用于操作 replication controllers。
getAll(namespace, callback)
: 获取指定 namespace 中的所有 replication controller。create(namespace, replicationController, callback)
: 在指定 namespace 中创建一个 replication controller。get(namespace, name, callback)
: 获取指定 namespace 中指定名称的 replication controller。update(namespace, name, replicationController, callback)
: 更新指定 namespace 中指定名称的 replication controller。delete(namespace, name, callback)
: 删除指定 namespace 中指定名称的 replication controller。
routes
routes
API 用于操作 routes。
getAll(namespace, callback)
: 获取指定 namespace 中的所有 route。create(namespace, route, callback)
: 在指定 namespace 中创建一个 route。get(namespace, name, callback)
: 获取指定 namespace 中指定名称的 route。update(namespace, name, route, callback)
: 更新指定 namespace 中指定名称的 route。delete(namespace, name, callback)
: 删除指定 namespace 中指定名称的 route。
secrets
secrets
API 用于操作 secrets。
getAll(namespace, callback)
: 获取指定 namespace 中的所有 secret。create(namespace, secret, callback)
: 在指定 namespace 中创建一个 secret。get(namespace, name, callback)
: 获取指定 namespace 中指定名称的 secret。update(namespace, name, secret, callback)
: 更新指定 namespace 中指定名称的 secret。delete(namespace, name, callback)
: 删除指定 namespace 中指定名称的 secret。
services
services
API 用于操作 services。
getAll(namespace, callback)
: 获取指定 namespace 中的所有 service。create(namespace, service, callback)
: 在指定 namespace 中创建一个 service。get(namespace, name, callback)
: 获取指定 namespace 中指定名称的 service。update(namespace, name, service, callback)
: 更新指定 namespace 中指定名称的 service。delete(namespace, name, callback)
: 删除指定 namespace 中指定名称的 service。
结束语
@absa-subatomic/openshift-api 包提供了一些丰富、方便的 API,我们可以用它来简化 OpenShift API 的操作。在使用的过程中,我们需要注意一些命名空间、验证等相关的问题。更多的功能和细节可以查看官方文档。如果您在使用过程中遇到了问题,可以随时在社区寻求帮助。
来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/60067357890c4f7277583da4