Architecture #4174: Deprecate API v1 - Rudder - Issue Tracker

Custom queries

8.1 beta
Bugs triage
CS - by priority
CS - to review
My TR
Need technical review
Open bugs (all)
Open bugs (UI - UX)
Open UX defects (all)
Opened by users

Actions

Copy link

Architecture #4174

closed

Deprecate API v1

Added by François ARMAND about 11 years ago. Updated about 4 years ago.

Status:

Resolved

Priority:

Assignee:

Category:

API

Target version:

6.2.0~beta1

Pull Request:

Effort required:

Name check:

Fix check:

Checked

Regression:

Description

We want to get rid of API v1, as it is not a good thing from a security point of view.

Before being able to deprecate it, we need to

- list all of there current use cases
- port functionality to API v2,
- find workaround or usage evolution for past use case not cover at identity.

That last point is important, especially if a feature relies one the non-authenticated aspect of API

To remember purpose, API v1 covers:

- api/status
- api/deploy/reload
- api/dyngroup/reload
- api/techniqueLibrary/reload
- api/archives/{list, archive, restore, zip}/...

A quick search raise the following usage in our code base:

- in Techniques
- initial-promises and system technique "distributePolicy", in aliveCheck.cf => "sites_to_check": /api/status
- system technique "distributePolicy", techniqueReload.st => root_technique_reload_rest_url: /api/techniqueLibrary/reload
- some tools look for Rudder status with "curl -s http://localhost/rudder/api/status"

So, before trying to decide what to do, do I miss other usage ?

Matthieu, assigned to you so that you see it, but it's just because I feel that the main usage of these API v1 may be in tooling around Rudder and Techniques... So as soon as you don't see any other usage, please pass the token to other (NicoP, NicoC, etc) so that they can react.

Subtasks 2 (0 open — 2 closed)

	Architecture #12565: V1 api uses case listing	Rejected	Pierre HAY				Actions
	Architecture #12577: API : upgrade of reload API endpoints to actual version	Rejected	Pierre HAY				Actions

Related issues 2 (0 open — 2 closed)

	Related to Rudder - User story #12516: Create system Rest API to replace V1 API	Released	Vincent MEMBRÉ				Actions
	Related to Rudder - Bug #18511: Remove API v1 endpoints	Released	Vincent MEMBRÉ				Actions

Issue # Delay: days Cancel

History
Notes
Property changes

Actions

Copy link

Updated by Vincent MEMBRÉ about 11 years ago

why not having a "default" api account that can only access to /api/status and /technique/reload, having a fixed token?

Actions

Copy link

Updated by François ARMAND about 11 years ago

How did you imagine that ?
I see at least two problem to overtake with that solution: the first is because we don't have authorization by API.
The second is: because having a default token-name with a fixed token is like having no authentication at all - and so, well, it's simpler to just kept the current situation.

Actions

Copy link

Updated by Vincent MEMBRÉ almost 11 years ago

Target version changed from 2.9.0~rc1 to 2.9.0~rc2

This won't be done for beta1

Actions

Copy link

Updated by Vincent MEMBRÉ almost 11 years ago

Target version changed from 2.9.0~rc2 to 2.9.0

Delayed to 2.9 finale release

Actions

Copy link

Updated by François ARMAND almost 11 years ago

Assignee changed from Matthieu CERDA to Nicolas CHARLES
Target version changed from 2.9.0 to 2.10.0~beta1

Actions

Copy link

Updated by Nicolas CHARLES over 10 years ago

And we also have rewrite in the apache configuration

The technique reload is necessary after upgrade, and used by touching a file on the FS, and then promises checking this files existance, and curling the API
The site status is only for checking site availability, and restarting various part in case of failure

How could we replace these calls ?

Actions

Copy link

Updated by François ARMAND over 10 years ago

I feels like the status URL could be kept. It has zero impact (no read nowhere, no update, nothing), just handling a URL, so nothing more than the login page. And if that one does not follow standard API naming (and can be called without authz token), that seems to be OK.

For technique reloading, it seems that we could have it in the standard API. But in that case, it means that local script need to have a token (not sur it is already the case).

Actions

Copy link