Documentation
¶
Overview ¶
Copyright 2024 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 2025 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 2024 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 2024 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 2025 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
- func AWSProviderSpecFromRawExtension(rawExtension *runtime.RawExtension) (mapiv1beta1.AWSMachineProviderConfig, error)
- func AWSProviderStatusFromRawExtension(rawExtension *runtime.RawExtension) (mapiv1beta1.AWSMachineProviderStatus, error)
- func ProviderSpecFromRawExtension(platform configv1.PlatformType, rawExtension *runtime.RawExtension) (any, error)
- type Machine
- type MachineSet
- func FromAWSMachineSetAndInfra(m *mapiv1beta1.MachineSet, i *configv1.Infrastructure) MachineSet
- func FromOpenStackMachineSetAndInfra(m *mapiv1beta1.MachineSet, i *configv1.Infrastructure) MachineSet
- func FromPowerVSMachineSetAndInfra(m *mapiv1beta1.MachineSet, i *configv1.Infrastructure) MachineSet
Constants ¶
const ( // DefaultCredentialsSecretName is the name of the default secret containing AWS cloud credentials. DefaultCredentialsSecretName = "aws-cloud-credentials" //#nosec G101 -- This is a false positive. )
Variables ¶
This section is empty.
Functions ¶
func AWSProviderSpecFromRawExtension ¶
func AWSProviderSpecFromRawExtension(rawExtension *runtime.RawExtension) (mapiv1beta1.AWSMachineProviderConfig, error)
AWSProviderSpecFromRawExtension unmarshals a raw extension into an AWSMachineProviderConfig type.
func AWSProviderStatusFromRawExtension ¶
func AWSProviderStatusFromRawExtension(rawExtension *runtime.RawExtension) (mapiv1beta1.AWSMachineProviderStatus, error)
AWSProviderStatusFromRawExtension unmarshals a raw extension into an AWSMachineProviderConfig type.
func ProviderSpecFromRawExtension ¶
func ProviderSpecFromRawExtension(platform configv1.PlatformType, rawExtension *runtime.RawExtension) (any, error)
ProviderSpecFromRawExtension converts a Machine API providerSpec to a Cluster API providerSpec.
Types ¶
type Machine ¶
type Machine interface {
ToMachineAndInfrastructureMachine() (*clusterv1.Machine, client.Object, []string, error)
}
Machine represents a type holding MAPI Machine.
func FromAWSMachineAndInfra ¶
func FromAWSMachineAndInfra(m *mapiv1beta1.Machine, i *configv1.Infrastructure) Machine
FromAWSMachineAndInfra wraps a Machine API Machine for AWS and the OCP Infrastructure object into a mapi2capi AWSProviderSpec.
func FromOpenStackMachineAndInfra ¶
func FromOpenStackMachineAndInfra(m *mapiv1beta1.Machine, i *configv1.Infrastructure) Machine
FromOpenStackMachineAndInfra wraps a Machine API Machine for OpenStack and the OCP Infrastructure object into a mapi2capi OpenstackProviderSpec.
func FromPowerVSMachineAndInfra ¶
func FromPowerVSMachineAndInfra(m *mapiv1beta1.Machine, i *configv1.Infrastructure) Machine
FromPowerVSMachineAndInfra wraps a Machine API Machine for PowerVS and the OCP Infrastructure object into a mapi2capi PowerVSProviderSpec.
type MachineSet ¶
type MachineSet interface {
ToMachineSetAndMachineTemplate() (*clusterv1.MachineSet, client.Object, []string, error)
}
MachineSet represents a type holding MAPI MachineSet.
func FromAWSMachineSetAndInfra ¶
func FromAWSMachineSetAndInfra(m *mapiv1beta1.MachineSet, i *configv1.Infrastructure) MachineSet
FromAWSMachineSetAndInfra wraps a Machine API MachineSet for AWS and the OCP Infrastructure object into a mapi2capi AWSProviderSpec.
func FromOpenStackMachineSetAndInfra ¶
func FromOpenStackMachineSetAndInfra(m *mapiv1beta1.MachineSet, i *configv1.Infrastructure) MachineSet
FromOpenStackMachineSetAndInfra wraps a Machine API MachineSet for OpenStack and the OCP Infrastructure object into a mapi2capi OpenstackProviderSpec.
func FromPowerVSMachineSetAndInfra ¶
func FromPowerVSMachineSetAndInfra(m *mapiv1beta1.MachineSet, i *configv1.Infrastructure) MachineSet
FromPowerVSMachineSetAndInfra wraps a Machine API MachineSet for Power VS and the OCP Infrastructure object into a mapi2capi PowerVSProviderSpec.