View a markdown version of this page

Mettre à niveau un domaine (SDK) - Amazon OpenSearch Service

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Mettre à niveau un domaine (SDK)

Cet exemple utilise le OpenSearchService client Python de bas niveau à partir du AWS SDK pour Python (Boto) pour vérifier si un domaine est éligible à la mise à niveau vers une version spécifique, le mettre à niveau et vérifier en permanence l'état de la mise à niveau.

Le premier exemple met à niveau un domaine en place. Le deuxième exemple exécute une mise à niveau basée sur un clone.

In-place mettre à niveau

import boto3 from botocore.config import Config import time # Build the client using the default credential configuration. # You can use the CLI and run 'aws configure' to set access key, secret # key, and default Region. DOMAIN_NAME = '' # The name of the domain to upgrade TARGET_VERSION = '' # The version you want to upgrade the domain to. For example, OpenSearch_1.1 my_config = Config( # Optionally lets you specify a Region other than your default. region_name='us-east-1' ) client = boto3.client('opensearch', config=my_config) def check_versions(): """Determine whether domain is eligible for upgrade""" response = client.get_compatible_versions( DomainName=DOMAIN_NAME ) compatible_versions = response['CompatibleVersions'] for i in range(len(compatible_versions)): if TARGET_VERSION in compatible_versions[i]["TargetVersions"]: print('Domain is eligible for upgrade to ' + TARGET_VERSION) upgrade_domain() print(response) else: print('Domain not eligible for upgrade to ' + TARGET_VERSION) def upgrade_domain(): """Upgrades the domain""" response = client.upgrade_domain( DomainName=DOMAIN_NAME, TargetVersion=TARGET_VERSION ) print('Upgrading domain to ' + TARGET_VERSION + '...' + response) time.sleep(5) wait_for_upgrade() def wait_for_upgrade(): """Get the status of the upgrade""" response = client.get_upgrade_status( DomainName=DOMAIN_NAME ) if (response['UpgradeStep']) == 'UPGRADE' and (response['StepStatus']) == 'SUCCEEDED': print('Domain successfully upgraded to ' + TARGET_VERSION) elif (response['StepStatus']) == 'FAILED': print('Upgrade failed. Please try again.') elif (response['StepStatus']) == 'SUCCEEDED_WITH_ISSUES': print('Upgrade succeeded with issues') elif (response['StepStatus']) == 'IN_PROGRESS': time.sleep(30) wait_for_upgrade() def main(): check_versions() if __name__ == "__main__": main()

Clone-based mettre à niveau

Cet exemple démarre une mise à niveau basée sur un clone, attend que le cluster cloné soit prêt, envoie 10 % du trafic de lecture au cluster cloné, puis interrompt ou annule. Pour plus d'informations sur chaque étape, voir Validation, découpage et restauration lors d'une mise à niveau basée sur un clone.

import boto3 import time DOMAIN_NAME = '' # The name of the domain to upgrade TARGET_VERSION = '' # The version to upgrade to. For example, OpenSearch_3.1 RETENTION_HOURS = 48 # How long to keep the primary cluster after cutover (maximum 336). Optional. client = boto3.client('opensearch', region_name='us-east-1') def start_upgrade(): """Starts a clone-based upgrade and returns the change ID""" response = client.upgrade_domain( DomainName=DOMAIN_NAME, TargetVersion=TARGET_VERSION, DeploymentStrategyOptions={ 'DeploymentStrategy': 'ClonedBlueGreen', 'ClonedBlueGreenOptions': { 'RetentionOptions': {'RetentionInHours': RETENTION_HOURS} } } ) return response['ChangeProgressDetails']['ChangeId'] def wait_for_cloned_cluster(change_id): """Waits until the cloned cluster is ready for validation""" while True: progress = client.describe_domain_change_progress( DomainName=DOMAIN_NAME, ChangeId=change_id )['ChangeProgressStatus'] if progress['ConfigChangeStatus'] == 'PendingUserInput': print('The cloned cluster is ready for validation') return if progress['Status'] in ('COMPLETED', 'FAILED'): raise RuntimeError('Upgrade ended with status ' + progress['Status']) time.sleep(60) def shift_read_traffic(percent): """Sends a share of read requests to the cloned cluster""" client.update_clone( DomainName=DOMAIN_NAME, TrafficSplitOptions={ 'Strategy': 'ShiftReadTrafficPercent', 'CloneReadTrafficPercent': percent } ) def cut_over(): """Cuts over to the cloned cluster""" client.update_clone( DomainName=DOMAIN_NAME, CutoverOptions={'Target': 'ClonedCluster'} ) def cancel(): """Cancels the upgrade before cutover and deletes the cloned cluster""" client.update_clone( DomainName=DOMAIN_NAME, CutoverOptions={'Target': 'PrimaryCluster'} ) def main(): change_id = start_upgrade() wait_for_cloned_cluster(change_id) shift_read_traffic(10) if input('Validate the cloned cluster, then type "cutover" to continue: ') == 'cutover': cut_over() else: cancel() if __name__ == "__main__": main()