Documentation
¶
Overview ¶
Copyright (c) 2019-2021 Red Hat, Inc. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Copyright (c) 2019-2021 Red Hat, Inc. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Copyright (c) 2019-2021 Red Hat, Inc. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Index ¶
Constants ¶
const ( // MetadataMountPathEnvVar is the name of an env var added to all containers to specify where workspace yamls are mounted. MetadataMountPathEnvVar = "DEVWORKSPACE_METADATA" // FlattenedDevfileMountPathEnvVar is an environment variable holding the path to the flattened devworkspace template spec FlattenedDevfileMountPathEnvVar = "DEVWORKSPACE_FLATTENED_DEVFILE" // OriginalDevfileMountPathEnvVar is an environment variable holding the path to the original devworkspace template spec OriginalDevfileMountPathEnvVar = "DEVWORKSPACE_ORIGINAL_DEVFILE" )
Variables ¶
This section is empty.
Functions ¶
func ProvisionWorkspaceMetadata ¶
func ProvisionWorkspaceMetadata(podAdditions *v1alpha1.PodAdditions, original, flattened *dw.DevWorkspace, api *wsprovision.ClusterAPI) error
ProvisionWorkspaceMetadata creates a configmap on the cluster that stores metadata about the workspace and configures all workspace containers to mount that configmap at /devworkspace-metadata. Each container has the environment variable DEVWORKSPACE_METADATA set to the mount path for the configmap
Types ¶
type NotReadyError ¶
type NotReadyError struct {
// Message is a user-friendly string explaining why the error occurred
Message string
// RequeueAfter represents how long we should wait before checking if storage is ready
RequeueAfter time.Duration
}
NotReadyError represents the state where no unexpected issues occurred but the provisioning required for the DevWorkspace is not ready
func (*NotReadyError) Error ¶
func (e *NotReadyError) Error() string
type ProvisioningError ¶
type ProvisioningError struct {
// Err is the underlying error causing the problem. If nil, it is not included in the output of Error()
Err error
// Message is a user-friendly string explaining why the error occurred
Message string
}
ProvisioningError represents an unrecoverable issue in provisioning a DevWorkspace.
func (*ProvisioningError) Error ¶
func (e *ProvisioningError) Error() string
Source Files