Project

General

Profile

Actions
Copy link

Architecture #12565

closed

Architecture #4174: Deprecate API v1

V1 api uses case listing

Added by Pierre HAY over 6 years ago. Updated about 6 years ago.

Status:
Rejected
Priority:
N/A
Assignee:
Pierre HAY
Category:
API
Target version:
-
Pull Request:
Effort required:
Name check:
Fix check:
Regression:

Description

V1 API Usecases
/status alive-check.st in techniques
/dyngroup/reload rudder server reload-groups
/techniqueLibrary/reload rudder server reload-techniques
post-hook ncf post.write_technique.90_reload.sh
rudder-setup (upgrade techniques)
/deploy/reload rudder-node-to-relay

It is also used in several places in the documentation (archives, monitoring, etc.)

Actions
Copy link
 #1

Updated by Pierre HAY over 6 years ago

  • Subject changed from V to V1 api uses case listing
  • Assignee set to Pierre HAY

We would like to have an exhaustive list of the V1 api uses cases in Rudder :

To start :


rudder-techniques
techniques/system/server-roles/1.0/alive-check.st
rudder-packages
rudder-webapp/SOURCES/rudder-node-to-relay
264:curl --proxy '' -k "https://localhost/rudder/api/deploy/reload" 

rudder-webapp/SOURCES/post.write_technique.90_reload.sh
48:curl --proxy '' -s -f "http://localhost:8080/rudder/api/techniqueLibrary/reload" 

rudder-webapp/SOURCES/rudder-apache-webapp-common.conf
68:<LocationMatch "^/rudder/api/(status|archives)$">
83:<LocationMatch "^/rudder/api/(techniqueLibrary|dyngroup|deploy)/reload$">

Actions
Copy link
 #2

Updated by Alexis Mousset over 6 years ago 

 ~/p/agent                                                                                                                                                        
share/commands/agent-info:HASH=$(openssl dgst -sha1 /var/rudder/cfengine-community/ppkeys/localhost.pub 2>/dev/null)
share/commands/agent-factory-reset:rm -f /var/rudder/cfengine-community/ppkeys/localhost*
share/commands/server-reload-groups:simple_api_call "https://localhost/rudder/api/dyngroup/reload" "reload dynamic groups" "${DISPLAY_COMMAND}" 
share/commands/server-reload-techniques:simple_api_call "http://localhost:8080/rudder/api/techniqueLibrary/reload" "reload techniques from files" "${DISPLAY_COMMAND}" 
share/lib/api_call.sh:      [ -z "${host}" ] && host="localhost"
Actions
Copy link
 #3

Updated by Alexis Mousset over 6 years ago

  • Description updated (diff)
Actions
Copy link
 #4

Updated by Alexis Mousset over 6 years ago

  • Description updated (diff)
Actions
Copy link
 #5

Updated by Alexis Mousset over 6 years ago

  • Description updated (diff)
Actions
Copy link
 #6

Updated by Alexis Mousset over 6 years ago

  • Description updated (diff)
Actions
Copy link
 #7

Updated by Alexis Mousset over 6 years ago

  • Description updated (diff)
Actions
Copy link
 #8

Updated by Alexis Mousset over 6 years ago

  • Description updated (diff)
Actions
Copy link
 #9

Updated by Alexis Mousset over 6 years ago

  • Description updated (diff)
Actions
Copy link
 #10

Updated by Alexis Mousset over 6 years ago

  • Description updated (diff)
Actions
Copy link
 #11

Updated by Alexis Mousset over 6 years ago

  • Description updated (diff)
Actions
Copy link
 #12

Updated by Pierre HAY over 6 years ago

The status endpoint and the reload endpoints as well are implemented :

We need to update the code everywhere the endpoints are called. (usecases listed above)

Actions
Copy link
 #13

Updated by Pierre HAY over 6 years ago

We need to have a discussion wheter the technique relaod enpoind should be part of the new system API or the existing Techniques API.
For now it is implemented as /system entity.

Actions
Copy link
 #14

Updated by Pierre HAY over 6 years ago

Pierre HAY wrote:

V1 API Usecases
/status alive-check.st in techniques
/dyngroup/reload rudder server reload-groups
/techniqueLibrary/reload rudder server reload-techniques
post-hook ncf post.write_technique.90_reload.sh
rudder-setup (upgrade techniques)
/deploy/reload rudder-node-to-relay

It is also used in several places in the documentation (archives, monitoring, etc.)

Endpoint evolution :

GET /rudder/api/status -> GET /rudder/api/latest/system/status
GET /rudder/api/dyngroup/reload -> POST /rudder/api/latest/system/action/groups/reload
GET /rudder/api/techniqueLibrary/reload -> POST /rudder/api/latest/system/action/techniques/reload
GET /rudder/api/deploy/reload -> POST /rudder/api/latest/system/action/policies/update

New endpoint :

POST /rudder/api/latest/system/action/reload (relaod everything)
POST /rudder/api/latest/system/action/policies/regenerate (update + clear cache)

Actions
Copy link
 #15

Updated by Alexis Mousset over 6 years ago

  • Category set to API
Actions
Copy link
 #16

Updated by Alexis Mousset about 6 years ago

  • Status changed from New to Rejected

This was released with parent as part of 5.0. Closing.

Actions
Copy link

Also available in: Atom PDF