Documentation Update

CHANGELOG.md

@@ -2,6 +2,10 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [3.10.1] - 2024-08-20
+### Fixed
+- Updated new fields Added support for ocean Automatic Rightsizing APIs (beta release. For internal use only).
+
 ## [3.10.0] - 2024-07-04
 ### Added
 - Added `initialNodes` query parameter for Ocean GKE `create_virtual_node_group` API.

docs/clients/ocean/ocean_gcp_client.md

@@ -131,7 +131,7 @@ OceanGcpClient.get_elastilog(ocean_id: str,
                              limit: int = None)
 ```
 
-Get group’s Elastilog by
+Get group's Elastilog by
 
 __Arguments__
 

spotinst_sdk2/clients/ocean/__init__.py

@@ -1988,7 +1988,7 @@ def reimport_ocean_cluster(self, ocean_id: str):
     def get_elastilog(self, ocean_id: str, from_date: str, to_date: str, severity: str = None, resource_id: str = None,
                       limit: int = None):
         """
-        Get group’s Elastilog by
+        Get group's Elastilog by
 
         # Arguments
         to_date (String): end date value
@@ -2490,7 +2490,7 @@ def launch_nodes_in_vng(self, ocean_launch_spec_id: str, amount: int):
 
 class OceanRightSizingClient(Client):
 
-    def create_right_sizing_rule(self, ocean_id: str, rule_name: str, restart_pods: bool, 
+    def create_right_sizing_rule(self, ocean_id: str, rule_name: str, restart_pods: bool,
                                  restart_replicas: right_sizing_ocean.RestartReplicas,
                                  exclude_preliminary_recommendations: bool,
                                  application_intervals: List[right_sizing_ocean.RecommendationApplicationInterval],
@@ -2723,8 +2723,8 @@ def get_ocean_right_sizing_recommendations(self, ocean_id: str, cluster_resource
 
         # Arguments
         ocean_id (String): ID of the Ocean Cluster
-        rule_name (String): Ocean right sizing rule
-        namespaces (List[Namespace]): List of namespaces to attach the right sizing rule to
+        cluster_resources (ClusterResources): Cluster Resources
+        cluster_labels (ClusterLabels): Cluster Labels
 
         # Returns
         (Object): Ocean Right Sizing Rule API response

spotinst_sdk2/models/ocean/rightsizing/__init__.py

@@ -288,10 +288,11 @@ def __init__(
 
 # endregion
 
+
 class RestartReplicas(Enum):
     More_than_one_replica = "MORE_THAN_ONE_REPLICA"
-    All_manifest          = "ALL_MANIFEST"
-    No_restart            = "NO_RESTART"
+    All_manifest = "ALL_MANIFEST"
+    No_restart = "NO_RESTART"
 
 
 class CreateRightSizingRuleRequest:
@@ -330,11 +331,15 @@ def toJSON(self):
 class UpdateRightSizingRuleRequest:
     def __init__(self,
                  restart_pods: bool,
+                 restart_replicas: RestartReplicas,
+                 exclude_preliminary_recommendations: bool,
                  recommendation_application_intervals: List[RecommendationApplicationInterval],
                  recommendation_application_threshold: RecommendationApplicationMinThreshold,
                  recommendation_application_boundaries: RecommendationApplicationBoundaries,
                  recommendation_application_overhead_values: RecommendationApplicationOverheadValues):
         self.restart_pods = restart_pods
+        self.restart_replicas = restart_replicas
+        self.exclude_preliminary_recommendations = exclude_preliminary_recommendations
         self.recommendation_application_intervals = recommendation_application_intervals
         self.recommendation_application_threshold = recommendation_application_threshold
         self.recommendation_application_boundaries = recommendation_application_boundaries

spotinst_sdk2/version.py

@@ -1 +1 @@
-__version__ = '3.10.0'
+__version__ = '3.10.1'