root
/
elasticsearch
mirror of https://github.com/elastic/elasticsearch.git
1
0
Fork 0
Code Issues Actions 1 Packages Projects Releases Wiki Activity
elasticsearch/docs/reference/autoscaling/apis/put-autoscaling-policy.asci...

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

93 lines
2.2 KiB
Plaintext
Raw Normal View History

Introduce autoscaling policies (#54473) This commit is the first in a series of commits that introduces autoscaling policies, and APIs for working with them. For now, we introduce the basic infrastructure, and a single API for putting an autoscaling policy. We will follow in rapid succession with APIs for getting, and deleting autoscaling policies.
2020-04-01 19:35:45 +08:00
[role="xpack"]
Autoscaling APIs not experimental (#67202) We no longer regard the autoscaling APIs experimental though they are only intended for use by ESS/ECE/ECK. This commit updates the docs to reflect this and adds a minimal set of documentation for the feature. Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
2021-01-13 05:03:18 +08:00
[testenv="enterprise"]
Introduce autoscaling policies (#54473) This commit is the first in a series of commits that introduces autoscaling policies, and APIs for working with them. For now, we introduce the basic infrastructure, and a single API for putting an autoscaling policy. We will follow in rapid succession with APIs for getting, and deleting autoscaling policies.
2020-04-01 19:35:45 +08:00
[[autoscaling-put-autoscaling-policy]]
[DOCS] Replace `put` with `create or update` in API names (#70330) Co-authored-by: debadair <debadair@elastic.co> Co-authored-by: Lisa Cawley <lcawley@elastic.co> Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2021-03-16 02:49:44 +08:00
=== Create or update autoscaling policy API
Introduce autoscaling policies (#54473) This commit is the first in a series of commits that introduces autoscaling policies, and APIs for working with them. For now, we introduce the basic infrastructure, and a single API for putting an autoscaling policy. We will follow in rapid succession with APIs for getting, and deleting autoscaling policies.
2020-04-01 19:35:45 +08:00
++++
[DOCS] Replace `put` with `create or update` in API names (#70330) Co-authored-by: debadair <debadair@elastic.co> Co-authored-by: Lisa Cawley <lcawley@elastic.co> Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2021-03-16 02:49:44 +08:00
<titleabbrev>Create or update autoscaling policy</titleabbrev>
Introduce autoscaling policies (#54473) This commit is the first in a series of commits that introduces autoscaling policies, and APIs for working with them. For now, we introduce the basic infrastructure, and a single API for putting an autoscaling policy. We will follow in rapid succession with APIs for getting, and deleting autoscaling policies.
2020-04-01 19:35:45 +08:00
++++
[DOCS] Replace hard-coded admons with cloud-only attribute (#70864)
2021-03-25 21:21:35 +08:00
NOTE: {cloud-only}
Autoscaling remove feature flags (#65973) Removed the autoscaling feature flags, autoscaling is now on by default (though it requires an external system to handle the autoscaling events). Added experimental notice to all autoscaling related documentation pages. Relates #51191
2020-12-15 02:06:09 +08:00
[DOCS] Replace `put` with `create or update` in API names (#70330) Co-authored-by: debadair <debadair@elastic.co> Co-authored-by: Lisa Cawley <lcawley@elastic.co> Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2021-03-16 02:49:44 +08:00
Creates or updates an autoscaling policy.
Introduce autoscaling policies (#54473) This commit is the first in a series of commits that introduces autoscaling policies, and APIs for working with them. For now, we introduce the basic infrastructure, and a single API for putting an autoscaling policy. We will follow in rapid succession with APIs for getting, and deleting autoscaling policies.
2020-04-01 19:35:45 +08:00
[[autoscaling-put-autoscaling-policy-request]]
==== {api-request-title}
[source,console]
--------------------------------------------------
PUT /_autoscaling/policy/<name>
{
Autoscaling policy roles specification (#64222) Add a roles specification to autoscaling policies. This is used to map the policy to a set of nodes governed by the policy. The list of roles is mandatory when adding a policy, optional on updates. This commit also removes the outer level "policy" element from autoscaling policy PUT and GET requests.
2020-11-02 14:30:31 +08:00
"roles": [],
"deciders": {
"fixed": {
Introduce autoscaling policies (#54473) This commit is the first in a series of commits that introduces autoscaling policies, and APIs for working with them. For now, we introduce the basic infrastructure, and a single API for putting an autoscaling policy. We will follow in rapid succession with APIs for getting, and deleting autoscaling policies.
2020-04-01 19:35:45 +08:00
}
}
}
--------------------------------------------------
// TEST[s/<name>/name/]
Autoscaling decider and decision service (#59005) Split the autoscaling decider into a service and configuration in order to enable having additional context information available in the service. Added AutoscalingDeciderContext holding generic information all deciders are expected to need. Implemented GET _autoscaling/decision
2020-08-10 18:02:25 +08:00
//////////////////////////
[source,console]
--------------------------------------------------
DELETE /_autoscaling/policy/name
--------------------------------------------------
// TEST[continued]
//////////////////////////
Introduce autoscaling policies (#54473) This commit is the first in a series of commits that introduces autoscaling policies, and APIs for working with them. For now, we introduce the basic infrastructure, and a single API for putting an autoscaling policy. We will follow in rapid succession with APIs for getting, and deleting autoscaling policies.
2020-04-01 19:35:45 +08:00
[[autoscaling-put-autoscaling-policy-prereqs]]
==== {api-prereq-title}
[DOCS] Add operator privileges to APIs and settings (#69903)
2021-03-15 21:20:09 +08:00
* If the {es} {security-features} are enabled, you must have the
`manage_autoscaling` <<privileges-list-cluster,cluster privilege>> to use this
API.
* If the <<operator-privileges,{operator-feature}>> is enabled, only operator
users can use this API.
Introduce autoscaling policies (#54473) This commit is the first in a series of commits that introduces autoscaling policies, and APIs for working with them. For now, we introduce the basic infrastructure, and a single API for putting an autoscaling policy. We will follow in rapid succession with APIs for getting, and deleting autoscaling policies.
2020-04-01 19:35:45 +08:00
[[autoscaling-put-autoscaling-policy-desc]]
==== {api-description-title}
This API puts an autoscaling policy with the provided name.
Autoscaling APIs not experimental (#67202) We no longer regard the autoscaling APIs experimental though they are only intended for use by ESS/ECE/ECK. This commit updates the docs to reflect this and adds a minimal set of documentation for the feature. Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
2021-01-13 05:03:18 +08:00
See <<autoscaling-deciders,Autoscaling Deciders>> for available deciders.
Introduce autoscaling policies (#54473) This commit is the first in a series of commits that introduces autoscaling policies, and APIs for working with them. For now, we introduce the basic infrastructure, and a single API for putting an autoscaling policy. We will follow in rapid succession with APIs for getting, and deleting autoscaling policies.
2020-04-01 19:35:45 +08:00
[[autoscaling-put-autoscaling-policy-examples]]
==== {api-examples-title}
Rename the policy in put autoscaling policy docs The put autoscaling policy docs use a "hot" policy as an example. Instead, this commit changes the name of this policy to "my_autoscaling_policy".
2020-04-02 04:30:26 +08:00
This example puts an autoscaling policy named `my_autoscaling_policy` using the
Autoscaling policy roles specification (#64222) Add a roles specification to autoscaling policies. This is used to map the policy to a set of nodes governed by the policy. The list of roles is mandatory when adding a policy, optional on updates. This commit also removes the outer level "policy" element from autoscaling policy PUT and GET requests.
2020-11-02 14:30:31 +08:00
fixed autoscaling decider, applying to the set of nodes having (only) the
"data_hot" role.
Introduce autoscaling policies (#54473) This commit is the first in a series of commits that introduces autoscaling policies, and APIs for working with them. For now, we introduce the basic infrastructure, and a single API for putting an autoscaling policy. We will follow in rapid succession with APIs for getting, and deleting autoscaling policies.
2020-04-01 19:35:45 +08:00
[source,console]
--------------------------------------------------
Rename the policy in put autoscaling policy docs The put autoscaling policy docs use a "hot" policy as an example. Instead, this commit changes the name of this policy to "my_autoscaling_policy".
2020-04-02 04:30:26 +08:00
PUT /_autoscaling/policy/my_autoscaling_policy
Introduce autoscaling policies (#54473) This commit is the first in a series of commits that introduces autoscaling policies, and APIs for working with them. For now, we introduce the basic infrastructure, and a single API for putting an autoscaling policy. We will follow in rapid succession with APIs for getting, and deleting autoscaling policies.
2020-04-01 19:35:45 +08:00
{
Autoscaling policy roles specification (#64222) Add a roles specification to autoscaling policies. This is used to map the policy to a set of nodes governed by the policy. The list of roles is mandatory when adding a policy, optional on updates. This commit also removes the outer level "policy" element from autoscaling policy PUT and GET requests.
2020-11-02 14:30:31 +08:00
"roles" : [ "data_hot" ],
"deciders": {
"fixed": {
Introduce autoscaling policies (#54473) This commit is the first in a series of commits that introduces autoscaling policies, and APIs for working with them. For now, we introduce the basic infrastructure, and a single API for putting an autoscaling policy. We will follow in rapid succession with APIs for getting, and deleting autoscaling policies.
2020-04-01 19:35:45 +08:00
}
}
}
--------------------------------------------------
// TEST
The API returns the following result:
[source,console-result]
--------------------------------------------------
{
"acknowledged": true
}
--------------------------------------------------
Autoscaling decider and decision service (#59005) Split the autoscaling decider into a service and configuration in order to enable having additional context information available in the service. Added AutoscalingDeciderContext holding generic information all deciders are expected to need. Implemented GET _autoscaling/decision
2020-08-10 18:02:25 +08:00
//////////////////////////
[source,console]
--------------------------------------------------
DELETE /_autoscaling/policy/my_autoscaling_policy
--------------------------------------------------
// TEST[continued]
//////////////////////////