[go: up one dir, main page]

PUT /application/settings doesn't accept same elasticsearch_url datatype as GET output

Summary

A large GitLab Premium customer reports internally that our API endpoint PUT /application/settings requires a different data type for elasticsearch_url (string), than GET /application/settings returns (array of strings).

Steps to reproduce

  1. On a test instance with Advanced Search enabled, create a PAT with read_api.
  2. curl -s -H "PRIVATE-TOKEN:${PRIVATE_TOKEN}" "${1ST_API_URL}/application/settings" > Gitlab_config.json
    • jq .elasticsearch_url < Gitlab_config.json yields ["https://…:9200"]
  3. On another instance with the same GitLab version, create a PAT with api scope.
  4. Try curl -s -X PUT -H "PRIVATE-TOKEN:"${PRIVATE_TOKEN} -H "Content-Type: application/json" ${2ND_API_URL}"/application/settings" -d "@Gitlab_config.json".

Our docs say that for importing, a string is needed.

Example Project

Internal test instances

What is the current bug behavior?

{"error":"elasticsearch_url is invalid"}%

What is the expected correct behavior?

The elasticsearch_url":["https://…:9200"] output should be accepted by the 2nd instance as is, without needing to remove the brackets.

Also, elasticsearch_url":["https://…:9200","https://…:9201"] yields the same error. It has to be elasticsearch_url":"https://…:9200,https://…:9201" to work, although the API outputs the array with 2 strings.

Relevant logs and/or screenshots

Output of checks

Results of GitLab environment info

Expand for output related to GitLab environment info 

# sudo gitlab-rake gitlab:env:info

System information
System:		Ubuntu 20.04
Proxy:		no
Current User:	git
Using RVM:	no
Ruby Version:	2.7.2p137
Gem Version:	3.1.4
Bundler Version:2.1.4
Rake Version:	13.0.3
Redis Version:	6.0.14
Git Version:	2.32.0
Sidekiq Version:5.2.9
Go Version:	unknown

GitLab information
Version:	14.1.3-ee
Revision:	77e6fa75d55
Directory:	/opt/gitlab/embedded/service/gitlab-rails
DB Adapter:	PostgreSQL
DB Version:	12.6
URL:		https://kl-258206a-sett-ex.sr.gitlab.support
HTTP Clone URL:	https://kl-258206a-sett-ex.sr.gitlab.support/some-group/some-project.git
SSH Clone URL:	git@kl-258206a-sett-ex.sr.gitlab.support:some-group/some-project.git
Elasticsearch:	yes
Geo:		no
Using LDAP:	no
Using Omniauth:	yes
Omniauth Providers:

GitLab Shell
Version:	13.19.1
Repository storage paths:
- default: 	/var/opt/gitlab/git-data/repositories
GitLab Shell path:		/opt/gitlab/embedded/service/gitlab-shell
Git:		/opt/gitlab/embedded/bin/git

Results of GitLab application Check

Expand for output related to the GitLab application check 
sudo gitlab-rake gitlab:check SANITIZE=true



Checking GitLab subtasks ...


Checking GitLab Shell ...


GitLab Shell: ... GitLab Shell version >= 13.19.1 ? ... OK (13.19.1)
Running /opt/gitlab/embedded/service/gitlab-shell/bin/check
Internal API available: OK
Redis available via internal API: OK
gitlab-shell self-check successful


Checking GitLab Shell ... Finished


Checking Gitaly ...


Gitaly: ... default ... OK


Checking Gitaly ... Finished


Checking Sidekiq ...


Sidekiq: ... Running? ... yes
Number of Sidekiq processes (cluster/worker) ... 1/1


Checking Sidekiq ... Finished


Checking Incoming Email ...


Incoming Email: ... Reply by email is disabled in config/gitlab.yml


Checking Incoming Email ... Finished


Checking LDAP ...


LDAP: ... LDAP is disabled in config/gitlab.yml


Checking LDAP ... Finished


Checking GitLab App ...


Git configured correctly? ... yes
Database config exists? ... yes
All migrations up? ... yes
Database contains orphaned GroupMembers? ... no
GitLab config exists? ... yes
GitLab config up to date? ... yes
Log directory writable? ... yes
Tmp directory writable? ... yes
Uploads directory exists? ... yes
Uploads directory has correct permissions? ... yes
Uploads directory tmp has correct permissions? ... yes
Init script exists? ... skipped (omnibus-gitlab has no init script)
Init script up-to-date? ... skipped (omnibus-gitlab has no init script)
Projects have namespace: ...
2/1 ... yes
Redis version >= 5.0.0? ... yes
Ruby version >= 2.7.2 ? ... yes (2.7.2)
Git version >= 2.31.0 ? ... yes (2.32.0)
Git user has default SSH configuration? ... yes
Active users: ... 1
Is authorized keys file accessible? ... yes
GitLab configured to store new projects in hashed storage? ... yes
All projects are in hashed storage? ... yes
Elasticsearch version 7.x (6.4 - 6.x deprecated to be removed in 13.8)? ... yes (7.16.2)


Checking GitLab App ... Finished


Checking GitLab subtasks ... Finished

Possible fixes

Edited by 🤖 GitLab Bot 🤖