From 8c4601b470041895647e09fad02f02edfe8afcdb Mon Sep 17 00:00:00 2001 From: jmc <33655003+jmcook1186@users.noreply.github.com> Date: Wed, 5 Jun 2024 15:09:25 +0100 Subject: [PATCH 1/3] fix(lib): add deprecation notices to teads curve and teads-aws plugins --- src/lib/teads-aws/README.md | 2 +- src/lib/teads-curve/README.md | 4 +++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/src/lib/teads-aws/README.md b/src/lib/teads-aws/README.md index 0c64a96..ff5e463 100644 --- a/src/lib/teads-aws/README.md +++ b/src/lib/teads-aws/README.md @@ -1,6 +1,6 @@ # Teads' AWS Estimation Plugin -> [!NOTE] > `Teads-AWS` is a community plugin, not part of the IF standard library. This means the IF core team are not closely monitoring these plugins to keep them up to date. You should do your own research before implementing them! +**This plugin is deprecated and will be deleted, likely before July 2024. We no longer want to support this plugin. It is possibel to replicate its behaviour using a set of generic arithmetic plugins that now come bundled in IF. You should start migrating your pipelines over to this method as soon as possible instead of relying on this plugin.** Teads Engineering Team built a plugin for estimating AWS instances energy usage. This plugin creates a power curve on a correlation to SPEC Power database. This allows the plugin to generate a power curve for any AWS EC2 instance type based on publicly available AWS EC2 Instance CPU data. diff --git a/src/lib/teads-curve/README.md b/src/lib/teads-curve/README.md index 28b6a1b..32d121e 100644 --- a/src/lib/teads-curve/README.md +++ b/src/lib/teads-curve/README.md @@ -1,6 +1,8 @@ # Teads' CPU Estimation Plugin -> [!NOTE] > `Teads-Curve` is a community plugin, not part of the IF standard library. This means the IF core team are not closely monitoring these plugins to keep them up to date. You should do your own research before implementing them! +**IMPORTANT** + +**This plugin is deprecated and will be deleted, likely before July 2024. Instead of providing a Teads plugin we have created a set of generic arithmetic plugins that can be chained together to replicate the behaviour of this plugin. We have added an example manifest to the IF repository to use as a template. You should start migrating your pipelines over to this method as soon as possible instead of relying on this Teads curve plugin.** Teads Engineering team has built a plugin that is capable of estimating CPU usages across varying type of CPUs using a curve commonly known as Teads Curve. From cf038dcee032c720117c9de11798d3a005396a01 Mon Sep 17 00:00:00 2001 From: jmc <33655003+jmcook1186@users.noreply.github.com> Date: Wed, 5 Jun 2024 15:51:55 +0100 Subject: [PATCH 2/3] fix(lib): add caution markdown --- src/lib/teads-aws/README.md | 2 +- src/lib/teads-curve/README.md | 4 +--- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/src/lib/teads-aws/README.md b/src/lib/teads-aws/README.md index ff5e463..9e4b35b 100644 --- a/src/lib/teads-aws/README.md +++ b/src/lib/teads-aws/README.md @@ -1,6 +1,6 @@ # Teads' AWS Estimation Plugin -**This plugin is deprecated and will be deleted, likely before July 2024. We no longer want to support this plugin. It is possibel to replicate its behaviour using a set of generic arithmetic plugins that now come bundled in IF. You should start migrating your pipelines over to this method as soon as possible instead of relying on this plugin.** +[!CAUTION] **This plugin is deprecated and will be deleted, likely before July 2024. We no longer want to support this plugin. It is possibel to replicate its behaviour using a set of generic arithmetic plugins that now come bundled in IF. You should start migrating your pipelines over to this method as soon as possible instead of relying on this plugin.** Teads Engineering Team built a plugin for estimating AWS instances energy usage. This plugin creates a power curve on a correlation to SPEC Power database. This allows the plugin to generate a power curve for any AWS EC2 instance type based on publicly available AWS EC2 Instance CPU data. diff --git a/src/lib/teads-curve/README.md b/src/lib/teads-curve/README.md index 32d121e..be35661 100644 --- a/src/lib/teads-curve/README.md +++ b/src/lib/teads-curve/README.md @@ -1,8 +1,6 @@ # Teads' CPU Estimation Plugin -**IMPORTANT** - -**This plugin is deprecated and will be deleted, likely before July 2024. Instead of providing a Teads plugin we have created a set of generic arithmetic plugins that can be chained together to replicate the behaviour of this plugin. We have added an example manifest to the IF repository to use as a template. You should start migrating your pipelines over to this method as soon as possible instead of relying on this Teads curve plugin.** +[!CAUTION] **This plugin is deprecated and will be deleted, likely before July 2024. Instead of providing a Teads plugin we have created a set of generic arithmetic plugins that can be chained together to replicate the behaviour of this plugin. We have added an example manifest to the IF repository to use as a template. You should start migrating your pipelines over to this method as soon as possible instead of relying on this Teads curve plugin.** Teads Engineering team has built a plugin that is capable of estimating CPU usages across varying type of CPUs using a curve commonly known as Teads Curve. From d74afe358b87d12047e9c6cf26e732b8d3b08a98 Mon Sep 17 00:00:00 2001 From: Joseph Cook <33655003+jmcook1186@users.noreply.github.com> Date: Thu, 6 Jun 2024 14:39:51 +0100 Subject: [PATCH 3/3] Apply suggestions from code review Signed-off-by: Joseph Cook <33655003+jmcook1186@users.noreply.github.com> --- src/lib/teads-aws/README.md | 2 +- src/lib/teads-curve/README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/lib/teads-aws/README.md b/src/lib/teads-aws/README.md index 9e4b35b..081c0a6 100644 --- a/src/lib/teads-aws/README.md +++ b/src/lib/teads-aws/README.md @@ -1,6 +1,6 @@ # Teads' AWS Estimation Plugin -[!CAUTION] **This plugin is deprecated and will be deleted, likely before July 2024. We no longer want to support this plugin. It is possibel to replicate its behaviour using a set of generic arithmetic plugins that now come bundled in IF. You should start migrating your pipelines over to this method as soon as possible instead of relying on this plugin.** +> [!CAUTION] **This plugin is deprecated and will be deleted, likely before July 2024. We no longer want to support this plugin. It is possible to replicate its behaviour using a set of generic arithmetic plugins that now come bundled in IF. You should start migrating your pipelines over to this method as soon as possible instead of relying on this plugin.** Teads Engineering Team built a plugin for estimating AWS instances energy usage. This plugin creates a power curve on a correlation to SPEC Power database. This allows the plugin to generate a power curve for any AWS EC2 instance type based on publicly available AWS EC2 Instance CPU data. diff --git a/src/lib/teads-curve/README.md b/src/lib/teads-curve/README.md index be35661..d95ef09 100644 --- a/src/lib/teads-curve/README.md +++ b/src/lib/teads-curve/README.md @@ -1,6 +1,6 @@ # Teads' CPU Estimation Plugin -[!CAUTION] **This plugin is deprecated and will be deleted, likely before July 2024. Instead of providing a Teads plugin we have created a set of generic arithmetic plugins that can be chained together to replicate the behaviour of this plugin. We have added an example manifest to the IF repository to use as a template. You should start migrating your pipelines over to this method as soon as possible instead of relying on this Teads curve plugin.** +> [!CAUTION] **This plugin is deprecated and will be deleted, likely before July 2024. Instead of providing a Teads plugin we have created a set of generic arithmetic plugins that can be chained together to replicate the behaviour of this plugin. We have added an example manifest to the IF repository to use as a template. You should start migrating your pipelines over to this method as soon as possible instead of relying on this Teads curve plugin.** Teads Engineering team has built a plugin that is capable of estimating CPU usages across varying type of CPUs using a curve commonly known as Teads Curve.