Remove ECS-EC2 Deprecated cfn template parameter (#126)

Author: daidokoro

opentelemetry/ecs-ec2/CHANGELOG.md

@@ -1,4 +1,7 @@
 # Changelog
+### 0.0.11 / 2024-04-05
+- Remove deprecated PrivateKey Param from ecs-ec2 otel deployment
+
 ### 0.0.10 / 2024-03-21
 - [cds-1099] set default force_flush_period parameter to 0 for ecs-ec2 otel filelog receiver
 

opentelemetry/ecs-ec2/README.md

@@ -50,7 +50,6 @@ A GRPC(*4317*) and HTTP(*4318*) endpoint is exposed for sending traces to the lo
 | ApplicationName  | You application name                                                                                                                                                                                                                 |                                                                              | :heavy_check_mark: |
 | SubsystemName    | You Subsystem name                                                                                                                                                                                                                   | AWS Account ID                                                               | :heavy_check_mark: |
 | CoralogixApiKey | The Send-Your-Data API key for your Coralogix account. See: https://coralogix.com/docs/send-your-data-api-key/ |                                                                              | :heavy_check_mark: |
-| PrivateKey :warning::no_entry:__Deprecated__.:no_entry::warning: | :warning::no_entry:__Deprecated__.:no_entry::warning: Do not use. Hard-replaced by `CoralogixApiKey`. Must be null. Formerly: Your Coralogix Private Key. |                                                                              | :no_entry: |
 | Metrics          | Enable/Disable Metrics                                                                                                                                                                                                               | disable                                                                      |                    |
 | OtelConfig       | The Base64 encoded Open Telemetry configuration yaml to use. This parameter allows you to pass your own Open Telemetry configuration. This will be used instead of the embedded configuration if specified.                          |                                                                              |                    |
 
@@ -63,7 +62,7 @@ aws cloudformation deploy --template-file template.yaml --stack-name <stack_name
         DefaultApplicationName=<application name> \
         CDOTImageVersion=<image tag> \
         ClusterName=<ecs cluster name> \
-        PrivateKey=<your-private-key> \
+        CoralogixApiKey=<your-private-key> \
         CoralogixRegion=<coralogix-region>
 ```
 
@@ -76,7 +75,7 @@ aws cloudformation deploy --template-file cfn_template.yaml --stack-name <stack_
         DefaultApplicationName=<application name> \
         ClusterName=<ecs cluster name> \
         CDOTImageVersion=<image tag> \
-        PrivateKey=<your-private-key> \
+        CoralogixApiKey=<your-private-key> \
         OtelConfig=$(cat path/to/otelconfig.yaml | base64) \
         CoralogixRegion=<coralogix-region>
 ```

opentelemetry/ecs-ec2/template.yaml

@@ -67,13 +67,6 @@ Parameters:
     AllowedPattern: ".+"
     ConstraintDescription: "API Key required."
 
-  PrivateKey:
-    Type: String
-    Description: "Deprecated. Do not use. Hard-replaced by \"CoralogixApiKey\". Formerly: The Coralogix private key which is used to validate your authenticity."
-    Default: "DO-NOT-USE"
-    AllowedPattern: "^DO-NOT-USE$" # hard-deprecate.
-    NoEcho: true
-
   Metrics:
     Type: String
     Description: If true, cadivisor will be deployed on each node to collect metrics