mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
OSDOCS-17763: Cluster API AWS pre-GA assorted TS updates
This commit is contained in:
Jeana Routh
committed by
openshift-cherrypick-robot
openshift-cherrypick-robot
parent
01e0201738
commit
f2b6ac74ec
@@ -6,13 +6,15 @@ include::_attributes/common-attributes.adoc[]
|
||||
|
||||
toc::[]
|
||||
|
||||
[role="_abstract"]
|
||||
To help avoid or recover from issues in a cluster that supports migrating resources to use a different authoritative API, you can learn how to recognize these issues.
|
||||
Generally, troubleshooting steps for problems with the Cluster API are similar to those steps for problems with the Machine API.
|
||||
|
||||
:FeatureName: Managing machines with the Cluster API
|
||||
include::snippets/technology-preview.adoc[]
|
||||
|
||||
Use the information in this section to understand and recover from issues you might encounter.
|
||||
Generally, troubleshooting steps for problems with the Cluster API are similar to those steps for problems with the Machine API.
|
||||
|
||||
The {cluster-capi-operator} and its operands are provisioned in the `openshift-cluster-api` namespace, whereas the Machine API uses the `openshift-machine-api` namespace. When using `oc` commands that reference a namespace, be sure to reference the correct one.
|
||||
The {cluster-capi-operator} and its operands are provisioned in the `openshift-cluster-api` namespace, whereas the Machine API uses the `openshift-machine-api` namespace.
|
||||
When using `oc` commands that reference a namespace, be sure to reference the correct one.
|
||||
|
||||
//Returning the intended machines when using the CLI
|
||||
include::modules/ts-capi-cli-reference-intended-objects.adoc[leveloffset=+1]
|
||||
@@ -23,19 +25,13 @@ include::modules/ts-capi-sync-list-duplicate-resources.adoc[leveloffset=+1]
|
||||
//Unexpected resource deletion behavior
|
||||
include::modules/ts-capi-migrate-unexpected-deletion-behavior.adoc[leveloffset=+1]
|
||||
|
||||
[id="ts-capi-resource-migration_{context}"]
|
||||
== Troubleshooting resource migration
|
||||
|
||||
When you migrate a resource to use a different authoritative API, you might encounter issues during the migration process.
|
||||
You might also notice unexpected behavior due to differences between the Cluster API and the Machine API.
|
||||
//Troubleshooting resource migration
|
||||
include::modules/ts-capi-resource-migration.adoc[leveloffset=+1]
|
||||
|
||||
//Authoritative API types of compute machines
|
||||
include::modules/machine-set-authoritative-api-machines.adoc[leveloffset=+2]
|
||||
|
||||
//Unexpected machine counts after scaling
|
||||
include::modules/ts-capi-migrate-unexpected-machine-counts-scaling.adoc[leveloffset=+2]
|
||||
|
||||
//Incomplete synchronization of labels and annotations
|
||||
//Incomplete synchronization of labels and annotations
|
||||
include::modules/ts-capi-migrate-sync-label-annotation.adoc[leveloffset=+2]
|
||||
|
||||
//Migrating {aws-short} cloud credentials
|
||||
|
||||
@@ -1,46 +0,0 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * machine_management/cluster_api_machine_management/cluster-api-troubleshooting.adoc
|
||||
|
||||
:_mod-docs-content-type: CONCEPT
|
||||
[id="ts-capi-migrate-unexpected-machine-counts-scaling_{context}"]
|
||||
= Unexpected machine counts after scaling
|
||||
|
||||
On clusters that support migrating resources between the Machine API and the Cluster API, users might experience unexpected behavior when scaling the number of compute machines.
|
||||
The output of the `oc get` command for a compute machine set that does not use the authoritative API might contain inaccurate values in the `CURRENT`, `READY`, and `AVAILABLE` columns.
|
||||
|
||||
Cause::
|
||||
|
||||
The values that populate the `CURRENT`, `READY`, and `AVAILABLE` columns originate in the `.status` stanza of a compute machine set.
|
||||
The two-way synchronization controller that handles resource conversion between authoritative API types does not currently synchronize values in the `.status` stanza.
|
||||
+
|
||||
The value in the `DESIRED` column reflects the `.spec.replicas` value of a compute machine set.
|
||||
The two-way synchronization controller synchronizes values in the `.spec` stanza.
|
||||
|
||||
Consequence::
|
||||
|
||||
Users can expect to see the following behavior when scaling migrated machine sets:
|
||||
+
|
||||
--
|
||||
. Start with a compute machine set with existing machines.
|
||||
. Migrate the machine set to use a different authoritative API.
|
||||
. Scale the now authoritative machine set up by setting a larger value in the `.spec.replicas` field.
|
||||
. The machine set creates machines with the current authoritative API to satisfy the number of requested replicas.
|
||||
. Scale the authoritative machine set down such that one of the following conditions causes the deletion of machines that do not use the current authoritative API:
|
||||
** The total number of replicas requested is fewer than the number of machines that do not use the current authoritative API.
|
||||
** The machine deletion policy for the machine set selects machines that do not use the current authoritative API.
|
||||
. Check the status of the nonauthoritative compute machine set by running the `oc get` command.
|
||||
** The value in the `DESIRED` column in the output reflects the `.spec.replicas` value.
|
||||
** The values in the `CURRENT`, `READY`, and `AVAILABLE` columns reflect the original number of replicas that existed before scaling the machine set.
|
||||
--
|
||||
|
||||
Workaround::
|
||||
|
||||
To verify that a scale-down operation successfully deleted the compute machines that do not use the current authoritative API, run the `oc get` command that lists the nonauthoritative compute machines.
|
||||
|
||||
Result::
|
||||
|
||||
If the scale-down operation succeeded, the count in the output of the `oc get` command for the nonauthoritative compute machines reflects the `.spec.replicas` value of the machine set.
|
||||
|
||||
//OCPCLOUD-2994
|
||||
//OCPCLOUD-2995
|
||||
@@ -6,11 +6,14 @@
|
||||
[id="ts-capi-migrate-unsupported-features_{context}"]
|
||||
= Unsupported configuration options
|
||||
|
||||
[role="_abstract"]
|
||||
To understand whether the Cluster API meets your requirements, you can learn about unsupported configuration options.
|
||||
|
||||
The Machine API does not support all configuration options for the Cluster API.
|
||||
Some Machine API configurations cannot migrate to the Cluster API.
|
||||
Additional configuration options might be supported in a future release.
|
||||
|
||||
Attempting to use the following configurations might cause a migration to fail or result in errors.
|
||||
Attempting to use unsupported configurations might cause a migration to fail or result in errors.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
@@ -28,7 +31,6 @@ The following limitations apply to all clusters:
|
||||
|
||||
** `version`
|
||||
** `readinessGates`
|
||||
//OCPCLOUD-2714
|
||||
|
||||
* The Machine API does not support using the following Cluster API drain configuration options:
|
||||
|
||||
@@ -37,17 +39,11 @@ The following limitations apply to all clusters:
|
||||
** `nodeDeletionTimeout`
|
||||
//OCPCLOUD-2715
|
||||
|
||||
* The Cluster API does not support propagating labels or taints from machines to nodes.
|
||||
//OCPCLOUD-2861
|
||||
|
||||
[id="ts-capi-migrate-unsupported-features-aws_{context}"]
|
||||
== {aws-first} limitations
|
||||
|
||||
The following limitations apply to {aws-short} clusters:
|
||||
|
||||
* Machine API compute machines cannot use {aws-short} load balancers.
|
||||
//OCPCLOUD-2709
|
||||
|
||||
* The Machine API does not support using the following Amazon EC2 Instance Metadata Service (IMDS) configuration options:
|
||||
+
|
||||
--
|
||||
@@ -79,11 +75,6 @@ The underlying instances will continue to use these settings.
|
||||
** `spec.privateDNSName`
|
||||
** `spec.securityGroupOverrides`
|
||||
** `spec.uncompressedUserData`
|
||||
//OCPCLOUD-2711
|
||||
|
||||
* The Cluster API does not support orphaning a nonroot EBS volume when its underlying {aws-short} EC2 instance is removed.
|
||||
* The Cluster API does not support orphaning a nonroot Amazon Elastic Block Store (Amazon EBS) volume when its underlying {aws-short} EC2 instance is removed.
|
||||
When an instance is terminated, the Cluster API removes all dependent volumes.
|
||||
//OCPCLOUD-2717
|
||||
|
||||
* When migrating a Machine API resource to the Cluster API, the ignition version is hard-coded and might not match the user data secret that is passed through.
|
||||
//OCPCLOUD-2719
|
||||
|
||||
12
modules/ts-capi-resource-migration.adoc
Normal file
12
modules/ts-capi-resource-migration.adoc
Normal file
@@ -0,0 +1,12 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * machine_management/cluster_api_machine_management/cluster-api-troubleshooting.adoc
|
||||
|
||||
:_mod-docs-content-type: CONCEPT
|
||||
|
||||
[id="ts-capi-resource-migration_{context}"]
|
||||
= Troubleshooting resource migration
|
||||
|
||||
[role="_abstract"]
|
||||
To help avoid or recover from issues when you migrate a resource to use a different authoritative API, you can learn how to recognize these issues.
|
||||
To understand unexpected behavior in your cluster, you can learn about differences between the Cluster API and the Machine API.
|
||||
Reference in New Issue
Block a user