Package cz.xtf.core.openshift
Class OpenShift
- java.lang.Object
-
- io.fabric8.kubernetes.client.SimpleClientContext
-
- io.fabric8.kubernetes.client.BaseClient
-
- io.fabric8.kubernetes.client.BaseKubernetesClient<io.fabric8.openshift.client.NamespacedOpenShiftClient>
-
- io.fabric8.openshift.client.DefaultOpenShiftClient
-
- cz.xtf.core.openshift.OpenShift
-
- All Implemented Interfaces:
io.fabric8.kubernetes.client.Client,io.fabric8.kubernetes.client.ClientContext,io.fabric8.kubernetes.client.ConfigAware<io.fabric8.kubernetes.client.Config>,io.fabric8.kubernetes.client.dsl.AnyNamespaceable<io.fabric8.openshift.client.NamespacedOpenShiftClient>,io.fabric8.kubernetes.client.dsl.Namespaceable<io.fabric8.openshift.client.NamespacedOpenShiftClient>,io.fabric8.kubernetes.client.dsl.RequestConfigurable<io.fabric8.openshift.client.NamespacedOpenShiftClient>,io.fabric8.kubernetes.client.GenericKubernetesClient<io.fabric8.openshift.client.NamespacedOpenShiftClient>,io.fabric8.kubernetes.client.HttpClientAware,io.fabric8.kubernetes.client.KubernetesClient,io.fabric8.openshift.client.NamespacedOpenShiftClient,io.fabric8.openshift.client.OpenShiftClient,io.fabric8.openshift.client.OpenshiftClientContext,Closeable,AutoCloseable
public class OpenShift extends io.fabric8.openshift.client.DefaultOpenShiftClient
-
-
Field Summary
Fields Modifier and Type Field Description static StringKEEP_LABELstatic com.google.common.collect.Multimap<String,OpenShift>namespaceToOpenshiftClientMapUsed to cache created Openshift clients for given test case.static StringXTF_MANAGED_LABELThis label is supposed to be used for any resource created by the XTF to easily distinguish which resources have been created by XTF automation.-
Fields inherited from class io.fabric8.openshift.client.DefaultOpenShiftClient
OPENSHIFT_VERSION_ENDPOINT
-
-
Constructor Summary
Constructors Constructor Description OpenShift(io.fabric8.openshift.client.OpenShiftConfig openShiftConfig)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description io.fabric8.kubernetes.api.model.rbac.RoleBindingaddRoleToGroup(String roleName, String groupName)Deprecated.use methodaddRoleToGroup(String, String, String)io.fabric8.kubernetes.api.model.rbac.RoleBindingaddRoleToGroup(String roleName, String roleKind, String groupName)io.fabric8.kubernetes.api.model.rbac.RoleBindingaddRoleToServiceAccount(String roleName, String serviceAccountName)io.fabric8.kubernetes.api.model.rbac.RoleBindingaddRoleToServiceAccount(String roleName, String serviceAccountName, String namespace)io.fabric8.kubernetes.api.model.rbac.RoleBindingaddRoleToServiceAccount(String roleName, String roleKind, String serviceAccountName, String namespace)io.fabric8.kubernetes.api.model.rbac.RoleBindingaddRoleToUser(String roleName, String username)io.fabric8.kubernetes.api.model.rbac.RoleBindingaddRoleToUser(String roleName, String roleKind, String username)Waiterclean()Deletes all* resources in namespace.io.fabric8.openshift.api.model.BuildConfigcreateBuildConfig(io.fabric8.openshift.api.model.BuildConfig buildConfig)io.fabric8.kubernetes.api.model.ConfigMapcreateConfigMap(io.fabric8.kubernetes.api.model.ConfigMap configMap)io.fabric8.openshift.api.model.DeploymentConfigcreateDeploymentConfig(io.fabric8.openshift.api.model.DeploymentConfig deploymentConfig)io.fabric8.kubernetes.api.model.EndpointscreateEndpoint(io.fabric8.kubernetes.api.model.Endpoints endpoint)io.fabric8.kubernetes.api.model.autoscaling.v1.HorizontalPodAutoscalercreateHorizontalPodAutoscaler(io.fabric8.kubernetes.api.model.autoscaling.v1.HorizontalPodAutoscaler hpa)io.fabric8.openshift.api.model.ImageStreamcreateImageStream(io.fabric8.openshift.api.model.ImageStream imageStream)io.fabric8.openshift.api.model.ImageStreamTagcreateImageStreamTag(io.fabric8.openshift.api.model.ImageStreamTag imageStreamTag)io.fabric8.kubernetes.api.model.PersistentVolumeClaimcreatePersistentVolumeClaim(io.fabric8.kubernetes.api.model.PersistentVolumeClaim pvc)io.fabric8.kubernetes.api.model.PodcreatePod(io.fabric8.kubernetes.api.model.Pod pod)io.fabric8.openshift.api.model.ProjectRequestcreateProjectRequest()io.fabric8.openshift.api.model.ProjectRequestcreateProjectRequest(io.fabric8.openshift.api.model.ProjectRequest projectRequest)io.fabric8.openshift.api.model.ProjectRequestcreateProjectRequest(String name)io.fabric8.kubernetes.api.model.ResourceQuotacreateResourceQuota(io.fabric8.kubernetes.api.model.ResourceQuota resourceQuota)io.fabric8.kubernetes.api.model.KubernetesListcreateResources(io.fabric8.kubernetes.api.model.HasMetadata... resources)io.fabric8.kubernetes.api.model.KubernetesListcreateResources(io.fabric8.kubernetes.api.model.KubernetesList resources)io.fabric8.kubernetes.api.model.KubernetesListcreateResources(List<io.fabric8.kubernetes.api.model.HasMetadata> resources)io.fabric8.kubernetes.api.model.rbac.RoleBindingcreateRoleBinding(io.fabric8.kubernetes.api.model.rbac.RoleBinding roleBinding)io.fabric8.openshift.api.model.RoutecreateRoute(io.fabric8.openshift.api.model.Route route)io.fabric8.kubernetes.api.model.SecretcreateSecret(io.fabric8.kubernetes.api.model.Secret secret)io.fabric8.kubernetes.api.model.ServicecreateService(io.fabric8.kubernetes.api.model.Service service)io.fabric8.kubernetes.api.model.ServiceAccountcreateServiceAccount(io.fabric8.kubernetes.api.model.ServiceAccount serviceAccount)io.fabric8.kubernetes.api.model.apps.StatefulSetcreateStatefulSet(io.fabric8.kubernetes.api.model.apps.StatefulSet statefulSet)io.fabric8.openshift.api.model.TemplatecreateTemplate(io.fabric8.openshift.api.model.Template template)booleandeleteBuild(io.fabric8.openshift.api.model.Build build)booleandeleteBuildConfig(io.fabric8.openshift.api.model.BuildConfig buildConfig)booleandeleteConfigMap(io.fabric8.kubernetes.api.model.ConfigMap configMap)booleandeleteDeploymentConfig(io.fabric8.openshift.api.model.DeploymentConfig deploymentConfig)booleandeleteDeploymentConfig(io.fabric8.openshift.api.model.DeploymentConfig deploymentConfig, boolean cascading)booleandeleteEndpoint(io.fabric8.kubernetes.api.model.Endpoints endpoint)booleandeleteHorizontalPodAutoscaler(io.fabric8.kubernetes.api.model.autoscaling.v1.HorizontalPodAutoscaler hpa)booleandeleteImageStream(io.fabric8.openshift.api.model.ImageStream imageStream)booleandeleteImageStreamTag(io.fabric8.openshift.api.model.ImageStreamTag imageStreamTag)booleandeletePersistentVolumeClaim(io.fabric8.kubernetes.api.model.PersistentVolumeClaim pvc)booleandeletePod(io.fabric8.kubernetes.api.model.Pod pod)booleandeletePod(io.fabric8.kubernetes.api.model.Pod pod, long gracePeriod)booleandeletePods(String key, String value)Deletes pods with specified label.booleandeletePods(Map<String,String> labels)booleandeleteProject()booleandeleteProject(String name)booleandeleteResourceQuota(io.fabric8.kubernetes.api.model.ResourceQuota resourceQuota)booleandeleteResources(io.fabric8.kubernetes.api.model.KubernetesList resources)booleandeleteRoleBinding(io.fabric8.kubernetes.api.model.rbac.RoleBinding roleBinding)booleandeleteRoute(io.fabric8.openshift.api.model.Route route)booleandeleteSecret(io.fabric8.kubernetes.api.model.Secret secret)booleandeleteService(io.fabric8.kubernetes.api.model.Service service)booleandeleteServiceAccount(io.fabric8.kubernetes.api.model.ServiceAccount serviceAccount)booleandeleteTemplate(io.fabric8.openshift.api.model.Template template)booleandeleteTemplate(String name)voiddeployLatest(String name)Redeploys deployment config to latest version.StringgenerateHostname(String routeName)Generates hostname as is expected to be generated by OpenShift instance.static OpenShiftget(String namespace)Autoconfigures the client with the default fabric8 client rulesstatic OpenShiftget(String masterUrl, String namespace, String token)static OpenShiftget(String masterUrl, String namespace, String username, String password)static OpenShiftget(Path kubeconfigPath, String namespace)Map<String,Reader>getAllContainerLogReaders(io.fabric8.kubernetes.api.model.Pod pod)Return readers on logs of all containers from the podMap<String,String>getAllContainerLogs(io.fabric8.kubernetes.api.model.Pod pod)Return logs of all containers from the podList<io.fabric8.kubernetes.api.model.Container>getAllContainers(io.fabric8.kubernetes.api.model.Pod pod)Retrieve pod containersio.fabric8.kubernetes.api.model.ContainergetAnyContainer(io.fabric8.kubernetes.api.model.Pod pod)Retrieve any container from the given podio.fabric8.kubernetes.api.model.PodgetAnyPod(String deploymentConfigName)io.fabric8.kubernetes.api.model.PodgetAnyPod(String key, String value)io.fabric8.kubernetes.api.model.PodgetAnyPod(Map<String,String> labels)io.fabric8.openshift.api.model.BuildgetBuild(String name)io.fabric8.openshift.api.model.BuildConfiggetBuildConfig(String name)Map<String,String>getBuildConfigEnvVars(String name)Returns environment variables of buildConfig specified under sourceStrategy.List<io.fabric8.openshift.api.model.BuildConfig>getBuildConfigs()StringgetBuildLog(io.fabric8.openshift.api.model.Build build)ReadergetBuildLogReader(io.fabric8.openshift.api.model.Build build)List<io.fabric8.openshift.api.model.Build>getBuilds()io.fabric8.kubernetes.api.model.ConfigMapgetConfigMap(String name)List<io.fabric8.kubernetes.api.model.ConfigMap>getConfigMaps()io.fabric8.kubernetes.api.model.ContainergetContainer(io.fabric8.kubernetes.api.model.Pod pod, String containerName)protected static ServiceLoader<CustomResourceDefinitionContextProvider>getCRDContextProviders()io.fabric8.openshift.api.model.DeploymentConfiggetDeploymentConfig(String name)Map<String,String>getDeploymentConfigEnvVars(String name)Returns first container environment variables.List<io.fabric8.openshift.api.model.DeploymentConfig>getDeploymentConfigs()io.fabric8.kubernetes.api.model.EndpointsgetEndpoint(String name)List<io.fabric8.kubernetes.api.model.Endpoints>getEndpoints()EventListgetEventList()List<io.fabric8.kubernetes.api.model.Event>getEvents()Deprecated.io.fabric8.kubernetes.api.model.autoscaling.v1.HorizontalPodAutoscalergetHorizontalPodAutoscaler(String name)List<io.fabric8.kubernetes.api.model.autoscaling.v1.HorizontalPodAutoscaler>getHorizontalPodAutoscalers()io.fabric8.openshift.api.model.ImageStreamgetImageStream(String name)List<io.fabric8.openshift.api.model.ImageStream>getImageStreams()io.fabric8.openshift.api.model.ImageStreamTaggetImageStreamTag(String imageStreamName, String tag)List<io.fabric8.openshift.api.model.ImageStreamTag>getImageStreamTags()List<io.fabric8.kubernetes.api.model.Pod>getLabeledPods(String key, String value)List<io.fabric8.kubernetes.api.model.Pod>getLabeledPods(Map<String,String> labels)io.fabric8.openshift.api.model.BuildgetLatestBuild(String buildConfigName)io.fabric8.kubernetes.api.model.NodegetNode(String name)List<io.fabric8.kubernetes.api.model.Node>getNodes()List<io.fabric8.kubernetes.api.model.Node>getNodes(Map<String,String> labels)io.fabric8.kubernetes.api.model.PersistentVolumeClaimgetPersistentVolumeClaim(String name)List<io.fabric8.kubernetes.api.model.PersistentVolumeClaim>getPersistentVolumeClaims()io.fabric8.kubernetes.api.model.PodgetPod(String name)StringgetPodLog(io.fabric8.kubernetes.api.model.Pod pod)StringgetPodLog(io.fabric8.kubernetes.api.model.Pod pod, io.fabric8.kubernetes.api.model.Container container)StringgetPodLog(io.fabric8.kubernetes.api.model.Pod pod, String containerName)StringgetPodLog(String deploymentConfigName)ReadergetPodLogReader(io.fabric8.kubernetes.api.model.Pod pod)ReadergetPodLogReader(io.fabric8.kubernetes.api.model.Pod pod, io.fabric8.kubernetes.api.model.Container container)ReadergetPodLogReader(io.fabric8.kubernetes.api.model.Pod pod, String containerName)List<io.fabric8.kubernetes.api.model.Pod>getPods()List<io.fabric8.kubernetes.api.model.Pod>getPods(String deploymentConfigName)List<io.fabric8.kubernetes.api.model.Pod>getPods(String deploymentConfigName, int version)io.fabric8.openshift.api.model.ProjectgetProject()io.fabric8.openshift.api.model.ProjectgetProject(String name)Tries to retrieve project with name 'name'.io.fabric8.kubernetes.api.model.ResourceQuotagetResourceQuota(String name)io.fabric8.kubernetes.api.model.rbac.RolegetRole(String name)io.fabric8.kubernetes.api.model.rbac.RoleBindinggetRoleBinding(String name)List<io.fabric8.kubernetes.api.model.rbac.RoleBinding>getRoleBindings()List<io.fabric8.kubernetes.api.model.rbac.Role>getRoles()io.fabric8.openshift.api.model.RoutegetRoute(String name)List<io.fabric8.openshift.api.model.Route>getRoutes()io.fabric8.kubernetes.api.model.SecretgetSecret(String name)List<io.fabric8.kubernetes.api.model.Secret>getSecrets()io.fabric8.kubernetes.api.model.ServicegetService(String name)io.fabric8.kubernetes.api.model.ServiceAccountgetServiceAccount(String name)List<io.fabric8.kubernetes.api.model.ServiceAccount>getServiceAccounts()List<io.fabric8.kubernetes.api.model.Service>getServices()io.fabric8.kubernetes.api.model.apps.StatefulSetgetStatefulSet(String name)List<io.fabric8.kubernetes.api.model.apps.StatefulSet>getStatefulSets()io.fabric8.openshift.api.model.TemplategetTemplate(String name)List<io.fabric8.openshift.api.model.Template>getTemplates()List<io.fabric8.kubernetes.api.model.ConfigMap>getUserConfigMaps()Retrieves all configmaps but "kube-root-ca.crt" and "openshift-service-ca.crt" which are created out of the box.List<io.fabric8.kubernetes.api.model.rbac.RoleBinding>getUserRoleBindings()Retrieves role bindings that aren't considered default.List<io.fabric8.kubernetes.api.model.Secret>getUserSecrets()Retrieves secrets that aren't considered default.List<io.fabric8.kubernetes.api.model.ServiceAccount>getUserServiceAccounts()Retrieves service accounts that aren't considered default.io.fabric8.openshift.api.model.TemplateloadAndCreateTemplate(InputStream is)voidloadResource(InputStream is)Map<String,rx.Observable<String>>observeAllContainerLogs(io.fabric8.kubernetes.api.model.Pod pod)Return obervables on logs of all containers from the podrx.Observable<String>observePodLog(io.fabric8.kubernetes.api.model.Pod pod)rx.Observable<String>observePodLog(io.fabric8.kubernetes.api.model.Pod pod, io.fabric8.kubernetes.api.model.Container container)rx.Observable<String>observePodLog(io.fabric8.kubernetes.api.model.Pod pod, String containerName)rx.Observable<String>observePodLog(String dcName)PodShellpodShell(io.fabric8.kubernetes.api.model.Pod pod)PodShellpodShell(io.fabric8.kubernetes.api.model.Pod pod, String containerName)PodShellpodShell(String dcName)io.fabric8.kubernetes.client.LocalPortForwardportForward(io.fabric8.kubernetes.api.model.Pod pod, int remotePort, int localPort)io.fabric8.kubernetes.client.LocalPortForwardportForward(String deploymentConfigName, int remotePort, int localPort)io.fabric8.kubernetes.api.model.KubernetesListprocessAndDeployTemplate(String name, Map<String,String> parameters)io.fabric8.kubernetes.api.model.KubernetesListprocessTemplate(String name, Map<String,String> parameters)io.fabric8.kubernetes.api.model.KubernetesListrecreateAndProcessAndDeployTemplate(io.fabric8.openshift.api.model.Template template, Map<String,String> parameters)io.fabric8.kubernetes.api.model.KubernetesListrecreateAndProcessTemplate(io.fabric8.openshift.api.model.Template template, Map<String,String> parameters)io.fabric8.openshift.api.model.ProjectRequestrecreateProject()Calls recreateProject(namespace).io.fabric8.openshift.api.model.ProjectRequestrecreateProject(io.fabric8.openshift.api.model.ProjectRequest projectRequest)Creates or recreates project specified by projectRequest instance.io.fabric8.openshift.api.model.ProjectRequestrecreateProject(String name)Creates or recreates project specified by name.io.fabric8.kubernetes.api.model.rbac.RoleBindingremoveRoleFromEntity(String roleName, String entityKind, String entityName)io.fabric8.kubernetes.api.model.rbac.RoleBindingremoveRoleFromServiceAccount(String roleName, String serviceAccountName)voidscale(String name, int replicas)Scales deployment config to specified number of replicas.voidsetupPullSecret(String secret)voidsetupPullSecret(String name, String secret)Convenient method to create pull secret for authenticated image registries.io.fabric8.openshift.api.model.BuildstartBinaryBuild(String buildConfigName, File file)io.fabric8.openshift.api.model.BuildstartBuild(String buildConfigName)PathstoreBuildLog(io.fabric8.openshift.api.model.Build build, Path dirPath, String fileName)PathstorePodLog(io.fabric8.kubernetes.api.model.Pod pod, Path dirPath, String fileName)io.fabric8.openshift.api.model.BuildConfigupdateBuildConfig(io.fabric8.openshift.api.model.BuildConfig buildConfig)io.fabric8.openshift.api.model.BuildConfigupdateBuildConfigEnvVars(String name, Map<String,String> envVars)Updates build config with specified environment variables.io.fabric8.openshift.api.model.DeploymentConfigupdateDeploymentconfig(io.fabric8.openshift.api.model.DeploymentConfig deploymentConfig)io.fabric8.openshift.api.model.DeploymentConfigupdateDeploymentConfigEnvVars(String name, Map<String,String> envVars)Updates deployment config environment variables with envVars values.io.fabric8.kubernetes.api.model.rbac.RoleBindingupdateRoleBinding(io.fabric8.kubernetes.api.model.rbac.RoleBinding roleBinding)OpenShiftWaiterswaiters()Deprecated.-
Methods inherited from class io.fabric8.openshift.client.DefaultOpenShiftClient
adaptState, apiRequestCounts, bareMetalHosts, brokerTemplateInstances, buildConfigs, builds, clusterAutoscaling, clusterNetworks, clusterRoleBindings, clusterRoles, componentstatuses, config, console, credentialsRequests, currentUser, deploymentConfigs, egressNetworkPolicies, egressRouters, extensions, fromConfig, fromConfig, getConfiguration, getKubernetesVersion, getOpenshiftUrl, getOpenShiftV3Version, getOpenShiftV4Version, getVersion, groups, helmChartRepositories, hive, hostSubnets, identities, imageRegistryOperatorConfigs, images, imageSignatures, imageStreamImages, imageStreamImports, imageStreamMappings, imageStreams, imageStreamTags, imageTags, inAnyNamespace, inNamespace, kubeStorageVersionMigrator, leaderElector, load, localResourceAccessReviews, localSubjectAccessReviews, machine, machineConfigurations, monitoring, netNamespaces, networkAttachmentDefinitions, oAuthAccessTokens, oAuthAuthorizeTokens, oAuthClientAuthorizations, oAuthClients, operator, operatorHub, operatorPKIs, podSecurityPolicyReviews, podSecurityPolicySelfSubjectReviews, podSecurityPolicySubjectReviews, projectrequests, projects, quotas, rangeAllocations, resourceAccessReviews, resourceList, resourceList, roleBindingRestrictions, roleBindings, roles, routes, securityContextConstraints, selfSubjectRulesReviews, subjectAccessReviews, subjectRulesReviews, supportsOpenShiftAPIGroup, templateInstances, templates, tuned, userIdentityMappings, userOAuthAccessTokens, users, whereabouts, withRequestConfig
-
Methods inherited from class io.fabric8.kubernetes.client.BaseKubernetesClient
admissionRegistration, apiextensions, apiServices, apps, authorization, autoscaling, batch, bindings, certificates, certificateSigningRequests, configMaps, customResource, customResources, customResources, customResources, discovery, endpoints, events, flowControl, genericKubernetesResources, informers, informers, leases, limitRanges, lists, namespaces, network, nodes, persistentVolumeClaims, persistentVolumes, pods, policy, rbac, replicationControllers, resource, resource, resourceList, resourceList, resourceListFor, resourceQuotas, resources, run, runtimeClasses, scheduling, secrets, serviceAccounts, services, storage, tokenReviews, top, v1
-
Methods inherited from class io.fabric8.kubernetes.client.BaseClient
adapt, close, getApiGroup, getApiGroups, getApiResources, getApiVersion, getMasterUrl, getNamespace, getVersionInfo, isAdaptable, newState, rootPaths, supportsApiPath
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface io.fabric8.kubernetes.client.Client
adapt, close, getApiGroup, getApiGroups, getApiResources, getApiVersion, getMasterUrl, getNamespace, isAdaptable, rootPaths, supportsApiPath
-
Methods inherited from interface io.fabric8.kubernetes.client.KubernetesClient
admissionRegistration, apiextensions, apiServices, authorization, bindings, certificates, certificateSigningRequests, configMaps, customResource, customResources, customResources, customResources, discovery, endpoints, events, flowControl, genericKubernetesResources, genericKubernetesResources, informers, informers, leases, limitRanges, lists, namespaces, nodes, persistentVolumeClaims, persistentVolumes, pods, policy, replicationControllers, resource, resource, resourceList, resourceList, resourceQuotas, resources, resources, run, runtimeClasses, secrets, serviceAccounts, services, tokenReviews, top, v1
-
-
-
-
Field Detail
-
KEEP_LABEL
public static final String KEEP_LABEL
- See Also:
- Constant Field Values
-
namespaceToOpenshiftClientMap
public static final com.google.common.collect.Multimap<String,OpenShift> namespaceToOpenshiftClientMap
Used to cache created Openshift clients for given test case.
-
XTF_MANAGED_LABEL
public static final String XTF_MANAGED_LABEL
This label is supposed to be used for any resource created by the XTF to easily distinguish which resources have been created by XTF automation. NOTE: at the moment only place where this is used is for labeling namespaces. Other usages may be added in the future.- See Also:
- Constant Field Values
-
-
Method Detail
-
get
public static OpenShift get(String namespace)
Autoconfigures the client with the default fabric8 client rules- Parameters:
namespace- set namespace to the Openshift client instance- Returns:
- this Openshift client instance
-
get
public static OpenShift get(String masterUrl, String namespace, String username, String password)
-
getCRDContextProviders
protected static ServiceLoader<CustomResourceDefinitionContextProvider> getCRDContextProviders()
-
setupPullSecret
public void setupPullSecret(String secret)
-
setupPullSecret
public void setupPullSecret(String name, String secret)
Convenient method to create pull secret for authenticated image registries. The secret content must be provided in "dockerconfigjson" formar. E.g.:{"auths":{"registry.redhat.io":{"auth":"<REDACTED_TOKEN>"}}}Linking Secret to ServiceAccount is based on OpenShift documentation: https://docs.openshift.com/container-platform/4.2/openshift_images/managing-images/using-image-pull-secrets.html- Parameters:
name- of the Secret to be createdsecret- content of Secret in json format
-
createResources
public io.fabric8.kubernetes.api.model.KubernetesList createResources(io.fabric8.kubernetes.api.model.HasMetadata... resources)
-
createResources
public io.fabric8.kubernetes.api.model.KubernetesList createResources(List<io.fabric8.kubernetes.api.model.HasMetadata> resources)
-
createResources
public io.fabric8.kubernetes.api.model.KubernetesList createResources(io.fabric8.kubernetes.api.model.KubernetesList resources)
-
deleteResources
public boolean deleteResources(io.fabric8.kubernetes.api.model.KubernetesList resources)
-
loadResource
public void loadResource(InputStream is)
-
createProjectRequest
public io.fabric8.openshift.api.model.ProjectRequest createProjectRequest()
-
createProjectRequest
public io.fabric8.openshift.api.model.ProjectRequest createProjectRequest(String name)
-
createProjectRequest
public io.fabric8.openshift.api.model.ProjectRequest createProjectRequest(io.fabric8.openshift.api.model.ProjectRequest projectRequest)
-
recreateProject
public io.fabric8.openshift.api.model.ProjectRequest recreateProject()
Calls recreateProject(namespace).- Returns:
- project request
- See Also:
recreateProject(String)
-
recreateProject
public io.fabric8.openshift.api.model.ProjectRequest recreateProject(String name)
Creates or recreates project specified by name.- Parameters:
name- name of a project to be created- Returns:
- ProjectRequest instance
-
recreateProject
public io.fabric8.openshift.api.model.ProjectRequest recreateProject(io.fabric8.openshift.api.model.ProjectRequest projectRequest)
Creates or recreates project specified by projectRequest instance.- Parameters:
projectRequest- project request instance- Returns:
- ProjectRequest instance
-
getProject
public io.fabric8.openshift.api.model.Project getProject(String name)
Tries to retrieve project with name 'name'. Swallows KubernetesClientException if project doesn't exist or isn't accessible for user.- Parameters:
name- name of requested project.- Returns:
- Project instance if accessible otherwise null.
-
getProject
public io.fabric8.openshift.api.model.Project getProject()
-
deleteProject
public boolean deleteProject()
-
deleteProject
public boolean deleteProject(String name)
-
createImageStream
public io.fabric8.openshift.api.model.ImageStream createImageStream(io.fabric8.openshift.api.model.ImageStream imageStream)
-
getImageStream
public io.fabric8.openshift.api.model.ImageStream getImageStream(String name)
-
getImageStreams
public List<io.fabric8.openshift.api.model.ImageStream> getImageStreams()
-
createStatefulSet
public io.fabric8.kubernetes.api.model.apps.StatefulSet createStatefulSet(io.fabric8.kubernetes.api.model.apps.StatefulSet statefulSet)
-
getStatefulSet
public io.fabric8.kubernetes.api.model.apps.StatefulSet getStatefulSet(String name)
-
getStatefulSets
public List<io.fabric8.kubernetes.api.model.apps.StatefulSet> getStatefulSets()
-
deleteImageStream
public boolean deleteImageStream(io.fabric8.openshift.api.model.ImageStream imageStream)
-
createImageStreamTag
public io.fabric8.openshift.api.model.ImageStreamTag createImageStreamTag(io.fabric8.openshift.api.model.ImageStreamTag imageStreamTag)
-
getImageStreamTag
public io.fabric8.openshift.api.model.ImageStreamTag getImageStreamTag(String imageStreamName, String tag)
-
getImageStreamTags
public List<io.fabric8.openshift.api.model.ImageStreamTag> getImageStreamTags()
-
deleteImageStreamTag
public boolean deleteImageStreamTag(io.fabric8.openshift.api.model.ImageStreamTag imageStreamTag)
-
createPod
public io.fabric8.kubernetes.api.model.Pod createPod(io.fabric8.kubernetes.api.model.Pod pod)
-
getPod
public io.fabric8.kubernetes.api.model.Pod getPod(String name)
-
getPodLog
public String getPodLog(io.fabric8.kubernetes.api.model.Pod pod)
-
getPodLog
public String getPodLog(io.fabric8.kubernetes.api.model.Pod pod, io.fabric8.kubernetes.api.model.Container container)
-
getAllContainerLogs
public Map<String,String> getAllContainerLogs(io.fabric8.kubernetes.api.model.Pod pod)
Return logs of all containers from the pod- Parameters:
pod- Pod to retrieve from- Returns:
- Map of container name / logs
-
getPodLogReader
public Reader getPodLogReader(io.fabric8.kubernetes.api.model.Pod pod)
-
getPodLogReader
public Reader getPodLogReader(io.fabric8.kubernetes.api.model.Pod pod, String containerName)
-
getPodLogReader
public Reader getPodLogReader(io.fabric8.kubernetes.api.model.Pod pod, io.fabric8.kubernetes.api.model.Container container)
-
getAllContainerLogReaders
public Map<String,Reader> getAllContainerLogReaders(io.fabric8.kubernetes.api.model.Pod pod)
Return readers on logs of all containers from the pod- Parameters:
pod- Pod to retrieve from- Returns:
- Map of container name / reader
-
observePodLog
public rx.Observable<String> observePodLog(io.fabric8.kubernetes.api.model.Pod pod)
-
observePodLog
public rx.Observable<String> observePodLog(io.fabric8.kubernetes.api.model.Pod pod, String containerName)
-
observePodLog
public rx.Observable<String> observePodLog(io.fabric8.kubernetes.api.model.Pod pod, io.fabric8.kubernetes.api.model.Container container)
-
observeAllContainerLogs
public Map<String,rx.Observable<String>> observeAllContainerLogs(io.fabric8.kubernetes.api.model.Pod pod)
Return obervables on logs of all containers from the pod- Parameters:
pod- Pod to retrieve from- Returns:
- Map of container name / logs obervable
-
getPods
public List<io.fabric8.kubernetes.api.model.Pod> getPods()
-
getPods
public List<io.fabric8.kubernetes.api.model.Pod> getPods(String deploymentConfigName)
- Parameters:
deploymentConfigName- name of deploymentConfig- Returns:
- all active pods created by specified deploymentConfig
-
getPods
public List<io.fabric8.kubernetes.api.model.Pod> getPods(String deploymentConfigName, int version)
- Parameters:
deploymentConfigName- name of deploymentConfigversion- deployment version to be retrieved- Returns:
- active pods created by deploymentConfig with specified version
-
getLabeledPods
public List<io.fabric8.kubernetes.api.model.Pod> getLabeledPods(String key, String value)
-
getLabeledPods
public List<io.fabric8.kubernetes.api.model.Pod> getLabeledPods(Map<String,String> labels)
-
getAnyPod
public io.fabric8.kubernetes.api.model.Pod getAnyPod(String deploymentConfigName)
-
deletePod
public boolean deletePod(io.fabric8.kubernetes.api.model.Pod pod)
-
deletePod
public boolean deletePod(io.fabric8.kubernetes.api.model.Pod pod, long gracePeriod)
-
deletePods
public boolean deletePods(String key, String value)
Deletes pods with specified label.- Parameters:
key- key of the labelvalue- value of the label- Returns:
- True if any pod has been deleted
-
getAllContainers
public List<io.fabric8.kubernetes.api.model.Container> getAllContainers(io.fabric8.kubernetes.api.model.Pod pod)
Retrieve pod containers- Parameters:
pod- pod to retrieve in- Returns:
- List of containers of empty list if none ...
-
getAnyContainer
public io.fabric8.kubernetes.api.model.Container getAnyContainer(io.fabric8.kubernetes.api.model.Pod pod)
Retrieve any container from the given pod- Parameters:
pod- Pod to retrieve from- Returns:
- One random container from the pod
-
getContainer
public io.fabric8.kubernetes.api.model.Container getContainer(io.fabric8.kubernetes.api.model.Pod pod, String containerName)
-
createSecret
public io.fabric8.kubernetes.api.model.Secret createSecret(io.fabric8.kubernetes.api.model.Secret secret)
-
getSecret
public io.fabric8.kubernetes.api.model.Secret getSecret(String name)
-
getSecrets
public List<io.fabric8.kubernetes.api.model.Secret> getSecrets()
-
getUserSecrets
public List<io.fabric8.kubernetes.api.model.Secret> getUserSecrets()
Retrieves secrets that aren't considered default. Secrets that are left out contain type starting with 'kubernetes.io/'.- Returns:
- List of secrets that aren't considered default.
-
deleteSecret
public boolean deleteSecret(io.fabric8.kubernetes.api.model.Secret secret)
-
createService
public io.fabric8.kubernetes.api.model.Service createService(io.fabric8.kubernetes.api.model.Service service)
-
getService
public io.fabric8.kubernetes.api.model.Service getService(String name)
-
getServices
public List<io.fabric8.kubernetes.api.model.Service> getServices()
-
deleteService
public boolean deleteService(io.fabric8.kubernetes.api.model.Service service)
-
createEndpoint
public io.fabric8.kubernetes.api.model.Endpoints createEndpoint(io.fabric8.kubernetes.api.model.Endpoints endpoint)
-
getEndpoint
public io.fabric8.kubernetes.api.model.Endpoints getEndpoint(String name)
-
getEndpoints
public List<io.fabric8.kubernetes.api.model.Endpoints> getEndpoints()
-
deleteEndpoint
public boolean deleteEndpoint(io.fabric8.kubernetes.api.model.Endpoints endpoint)
-
createRoute
public io.fabric8.openshift.api.model.Route createRoute(io.fabric8.openshift.api.model.Route route)
-
getRoute
public io.fabric8.openshift.api.model.Route getRoute(String name)
-
getRoutes
public List<io.fabric8.openshift.api.model.Route> getRoutes()
-
deleteRoute
public boolean deleteRoute(io.fabric8.openshift.api.model.Route route)
-
generateHostname
public String generateHostname(String routeName)
Generates hostname as is expected to be generated by OpenShift instance.- Parameters:
routeName- prefix for route hostname- Returns:
- Hostname as is expected to be generated by OpenShift
-
createDeploymentConfig
public io.fabric8.openshift.api.model.DeploymentConfig createDeploymentConfig(io.fabric8.openshift.api.model.DeploymentConfig deploymentConfig)
-
getDeploymentConfig
public io.fabric8.openshift.api.model.DeploymentConfig getDeploymentConfig(String name)
-
getDeploymentConfigs
public List<io.fabric8.openshift.api.model.DeploymentConfig> getDeploymentConfigs()
-
getDeploymentConfigEnvVars
public Map<String,String> getDeploymentConfigEnvVars(String name)
Returns first container environment variables.- Parameters:
name- name of deploymentConfig- Returns:
- Map of environment variables
-
updateDeploymentconfig
public io.fabric8.openshift.api.model.DeploymentConfig updateDeploymentconfig(io.fabric8.openshift.api.model.DeploymentConfig deploymentConfig)
-
updateDeploymentConfigEnvVars
public io.fabric8.openshift.api.model.DeploymentConfig updateDeploymentConfigEnvVars(String name, Map<String,String> envVars)
Updates deployment config environment variables with envVars values.- Parameters:
name- name of deploymentConfigenvVars- environment variables- Returns:
- deployment config
-
deleteDeploymentConfig
public boolean deleteDeploymentConfig(io.fabric8.openshift.api.model.DeploymentConfig deploymentConfig)
-
deleteDeploymentConfig
public boolean deleteDeploymentConfig(io.fabric8.openshift.api.model.DeploymentConfig deploymentConfig, boolean cascading)
-
scale
public void scale(String name, int replicas)
Scales deployment config to specified number of replicas.- Parameters:
name- name of deploymentConfigreplicas- number of target replicas
-
deployLatest
public void deployLatest(String name)
Redeploys deployment config to latest version.- Parameters:
name- name of deploymentConfig
-
getBuild
public io.fabric8.openshift.api.model.Build getBuild(String name)
-
getLatestBuild
public io.fabric8.openshift.api.model.Build getLatestBuild(String buildConfigName)
-
getBuilds
public List<io.fabric8.openshift.api.model.Build> getBuilds()
-
getBuildLog
public String getBuildLog(io.fabric8.openshift.api.model.Build build)
-
getBuildLogReader
public Reader getBuildLogReader(io.fabric8.openshift.api.model.Build build)
-
deleteBuild
public boolean deleteBuild(io.fabric8.openshift.api.model.Build build)
-
startBuild
public io.fabric8.openshift.api.model.Build startBuild(String buildConfigName)
-
startBinaryBuild
public io.fabric8.openshift.api.model.Build startBinaryBuild(String buildConfigName, File file)
-
createBuildConfig
public io.fabric8.openshift.api.model.BuildConfig createBuildConfig(io.fabric8.openshift.api.model.BuildConfig buildConfig)
-
getBuildConfig
public io.fabric8.openshift.api.model.BuildConfig getBuildConfig(String name)
-
getBuildConfigs
public List<io.fabric8.openshift.api.model.BuildConfig> getBuildConfigs()
-
getBuildConfigEnvVars
public Map<String,String> getBuildConfigEnvVars(String name)
Returns environment variables of buildConfig specified under sourceStrategy.- Parameters:
name- name of buildConfig- Returns:
- environment variables
-
updateBuildConfig
public io.fabric8.openshift.api.model.BuildConfig updateBuildConfig(io.fabric8.openshift.api.model.BuildConfig buildConfig)
-
updateBuildConfigEnvVars
public io.fabric8.openshift.api.model.BuildConfig updateBuildConfigEnvVars(String name, Map<String,String> envVars)
Updates build config with specified environment variables.- Parameters:
name- name of buildConfigenvVars- environment variables- Returns:
- build config
-
deleteBuildConfig
public boolean deleteBuildConfig(io.fabric8.openshift.api.model.BuildConfig buildConfig)
-
createServiceAccount
public io.fabric8.kubernetes.api.model.ServiceAccount createServiceAccount(io.fabric8.kubernetes.api.model.ServiceAccount serviceAccount)
-
getServiceAccount
public io.fabric8.kubernetes.api.model.ServiceAccount getServiceAccount(String name)
-
getServiceAccounts
public List<io.fabric8.kubernetes.api.model.ServiceAccount> getServiceAccounts()
-
getUserServiceAccounts
public List<io.fabric8.kubernetes.api.model.ServiceAccount> getUserServiceAccounts()
Retrieves service accounts that aren't considered default. Service accounts that are left out from list:- builder
- default
- deployer
- Returns:
- List of service accounts that aren't considered default.
-
deleteServiceAccount
public boolean deleteServiceAccount(io.fabric8.kubernetes.api.model.ServiceAccount serviceAccount)
-
createRoleBinding
public io.fabric8.kubernetes.api.model.rbac.RoleBinding createRoleBinding(io.fabric8.kubernetes.api.model.rbac.RoleBinding roleBinding)
-
getRoleBinding
public io.fabric8.kubernetes.api.model.rbac.RoleBinding getRoleBinding(String name)
-
getRoleBindings
public List<io.fabric8.kubernetes.api.model.rbac.RoleBinding> getRoleBindings()
-
getRole
public io.fabric8.kubernetes.api.model.rbac.Role getRole(String name)
-
getRoles
public List<io.fabric8.kubernetes.api.model.rbac.Role> getRoles()
-
getUserRoleBindings
public List<io.fabric8.kubernetes.api.model.rbac.RoleBinding> getUserRoleBindings()
Retrieves role bindings that aren't considered default. Role bindings that are left out from list:- admin
- system:deployers
- system:image-builders
- system:image-pullers
- Returns:
- List of role bindings that aren't considered default.
-
deleteRoleBinding
public boolean deleteRoleBinding(io.fabric8.kubernetes.api.model.rbac.RoleBinding roleBinding)
-
addRoleToUser
public io.fabric8.kubernetes.api.model.rbac.RoleBinding addRoleToUser(String roleName, String username)
-
addRoleToUser
public io.fabric8.kubernetes.api.model.rbac.RoleBinding addRoleToUser(String roleName, String roleKind, String username)
-
addRoleToServiceAccount
public io.fabric8.kubernetes.api.model.rbac.RoleBinding addRoleToServiceAccount(String roleName, String serviceAccountName)
-
addRoleToServiceAccount
public io.fabric8.kubernetes.api.model.rbac.RoleBinding addRoleToServiceAccount(String roleName, String serviceAccountName, String namespace)
-
addRoleToServiceAccount
public io.fabric8.kubernetes.api.model.rbac.RoleBinding addRoleToServiceAccount(String roleName, String roleKind, String serviceAccountName, String namespace)
-
addRoleToGroup
@Deprecated public io.fabric8.kubernetes.api.model.rbac.RoleBinding addRoleToGroup(String roleName, String groupName)
Deprecated.use methodaddRoleToGroup(String, String, String)Most of the groups are `system:*` wide therefore use `kind: ClusterRole`- Parameters:
roleName- role namegroupName- group name- Returns:
- role binging
-
addRoleToGroup
public io.fabric8.kubernetes.api.model.rbac.RoleBinding addRoleToGroup(String roleName, String roleKind, String groupName)
-
updateRoleBinding
public io.fabric8.kubernetes.api.model.rbac.RoleBinding updateRoleBinding(io.fabric8.kubernetes.api.model.rbac.RoleBinding roleBinding)
-
removeRoleFromServiceAccount
public io.fabric8.kubernetes.api.model.rbac.RoleBinding removeRoleFromServiceAccount(String roleName, String serviceAccountName)
-
removeRoleFromEntity
public io.fabric8.kubernetes.api.model.rbac.RoleBinding removeRoleFromEntity(String roleName, String entityKind, String entityName)
-
createResourceQuota
public io.fabric8.kubernetes.api.model.ResourceQuota createResourceQuota(io.fabric8.kubernetes.api.model.ResourceQuota resourceQuota)
-
getResourceQuota
public io.fabric8.kubernetes.api.model.ResourceQuota getResourceQuota(String name)
-
deleteResourceQuota
public boolean deleteResourceQuota(io.fabric8.kubernetes.api.model.ResourceQuota resourceQuota)
-
createPersistentVolumeClaim
public io.fabric8.kubernetes.api.model.PersistentVolumeClaim createPersistentVolumeClaim(io.fabric8.kubernetes.api.model.PersistentVolumeClaim pvc)
-
getPersistentVolumeClaim
public io.fabric8.kubernetes.api.model.PersistentVolumeClaim getPersistentVolumeClaim(String name)
-
getPersistentVolumeClaims
public List<io.fabric8.kubernetes.api.model.PersistentVolumeClaim> getPersistentVolumeClaims()
-
deletePersistentVolumeClaim
public boolean deletePersistentVolumeClaim(io.fabric8.kubernetes.api.model.PersistentVolumeClaim pvc)
-
createHorizontalPodAutoscaler
public io.fabric8.kubernetes.api.model.autoscaling.v1.HorizontalPodAutoscaler createHorizontalPodAutoscaler(io.fabric8.kubernetes.api.model.autoscaling.v1.HorizontalPodAutoscaler hpa)
-
getHorizontalPodAutoscaler
public io.fabric8.kubernetes.api.model.autoscaling.v1.HorizontalPodAutoscaler getHorizontalPodAutoscaler(String name)
-
getHorizontalPodAutoscalers
public List<io.fabric8.kubernetes.api.model.autoscaling.v1.HorizontalPodAutoscaler> getHorizontalPodAutoscalers()
-
deleteHorizontalPodAutoscaler
public boolean deleteHorizontalPodAutoscaler(io.fabric8.kubernetes.api.model.autoscaling.v1.HorizontalPodAutoscaler hpa)
-
createConfigMap
public io.fabric8.kubernetes.api.model.ConfigMap createConfigMap(io.fabric8.kubernetes.api.model.ConfigMap configMap)
-
getConfigMap
public io.fabric8.kubernetes.api.model.ConfigMap getConfigMap(String name)
-
getConfigMaps
public List<io.fabric8.kubernetes.api.model.ConfigMap> getConfigMaps()
-
getUserConfigMaps
public List<io.fabric8.kubernetes.api.model.ConfigMap> getUserConfigMaps()
Retrieves all configmaps but "kube-root-ca.crt" and "openshift-service-ca.crt" which are created out of the box.- Returns:
- List of configmaps created by user
-
deleteConfigMap
public boolean deleteConfigMap(io.fabric8.kubernetes.api.model.ConfigMap configMap)
-
createTemplate
public io.fabric8.openshift.api.model.Template createTemplate(io.fabric8.openshift.api.model.Template template)
-
getTemplate
public io.fabric8.openshift.api.model.Template getTemplate(String name)
-
getTemplates
public List<io.fabric8.openshift.api.model.Template> getTemplates()
-
deleteTemplate
public boolean deleteTemplate(String name)
-
deleteTemplate
public boolean deleteTemplate(io.fabric8.openshift.api.model.Template template)
-
loadAndCreateTemplate
public io.fabric8.openshift.api.model.Template loadAndCreateTemplate(InputStream is)
-
recreateAndProcessTemplate
public io.fabric8.kubernetes.api.model.KubernetesList recreateAndProcessTemplate(io.fabric8.openshift.api.model.Template template, Map<String,String> parameters)
-
recreateAndProcessAndDeployTemplate
public io.fabric8.kubernetes.api.model.KubernetesList recreateAndProcessAndDeployTemplate(io.fabric8.openshift.api.model.Template template, Map<String,String> parameters)
-
processTemplate
public io.fabric8.kubernetes.api.model.KubernetesList processTemplate(String name, Map<String,String> parameters)
-
processAndDeployTemplate
public io.fabric8.kubernetes.api.model.KubernetesList processAndDeployTemplate(String name, Map<String,String> parameters)
-
getNode
public io.fabric8.kubernetes.api.model.Node getNode(String name)
-
getNodes
public List<io.fabric8.kubernetes.api.model.Node> getNodes()
-
getEventList
public EventList getEventList()
-
getEvents
@Deprecated public List<io.fabric8.kubernetes.api.model.Event> getEvents()
Deprecated.UsegetEventList()instead- Returns:
- list of events
-
portForward
public io.fabric8.kubernetes.client.LocalPortForward portForward(String deploymentConfigName, int remotePort, int localPort)
-
portForward
public io.fabric8.kubernetes.client.LocalPortForward portForward(io.fabric8.kubernetes.api.model.Pod pod, int remotePort, int localPort)
-
podShell
public PodShell podShell(io.fabric8.kubernetes.api.model.Pod pod)
-
clean
public Waiter clean()
Deletes all* resources in namespace. Doesn't wait till all are deleted. * Only user created configmaps, secrets, service accounts and role bindings are deleted. Default will remain.
- Returns:
- waiter (for cleaning all resources)
- See Also:
getUserConfigMaps(),getUserSecrets(),getUserServiceAccounts(),getUserRoleBindings()
-
storePodLog
public Path storePodLog(io.fabric8.kubernetes.api.model.Pod pod, Path dirPath, String fileName) throws IOException
- Throws:
IOException
-
storeBuildLog
public Path storeBuildLog(io.fabric8.openshift.api.model.Build build, Path dirPath, String fileName) throws IOException
- Throws:
IOException
-
waiters
@Deprecated public OpenShiftWaiters waiters()
Deprecated.- Returns:
- standard openshift waiters (with default fail fast checks)
-
-