fix: APISIX runs in the `/root` directory and reports errors #3220

Firstsawyou · 2021-01-08T07:16:43Z

What this PR does / why we need it:

Cause of the bug: After APISIX is started, the worker process has the authority of nobody ordinary user. When APISIX is in the /root directory, ordinary users do not have the authority to access the /root directory. Therefore, when APISIX is started, the error log error.log will show the following error message:

init_worker_by_lua error: /root/apisix-2.1/apisix/init.lua:89: module 'resty.worker.events' not found:
        no field package.preload['resty.worker.events']
        no file '/root/apisix-2.1//deps/share/lua/5.1/resty/worker/events.lua'
        no file '/root/apisix-2.1//deps/share/lua/5.1/resty/worker/events/init.lua'
        no file '/root/apisix-2.1/resty/worker/events.lua'
        no file '/root/apisix-2.1/resty/worker/events/init.lua'

The solution: it is forbidden to execute make run in the /root directory to run apisix.

close #3207

Pre-submission checklist:

Did you explain what problem does this PR solve? Or what new features have been added?
Have you added corresponding test cases?
Have you modified the corresponding document?
Is this PR backward compatible? If it is not backward compatible, please discuss on the mailing list first

…run apisix. close apache#3207

Makefile

spacewander · 2021-01-08T10:10:15Z

Makefile

-	@echo "Non-zero exit status: 1"
-	@echo "Error, It is forbidden to run APISIX in the /root directory."
+	@echo "Error: It is forbidden to run APISIX in the /root directory."
+	@exit 1


We need to add a test for it.

I don't know how to add test cases for Makefile. Can you give me some suggestions?

See

apisix/.travis/apisix_cli_test/test_main.sh

Line 920 in ebd158a

out=$(make init 2>&1 || true)

Ok, got it.

moonming · 2021-01-09T01:42:15Z

I don't think this method can completely solve the permission problem. Can an error be thrown if the code file cannot be found in the init phase of apisix?

Firstsawyou · 2021-01-09T02:30:37Z

I don't think this method can completely solve the permission problem. Can an error be thrown if the code file cannot be found in the init phase of apisix?

There will be no errors when executing make init. Only when make run is executed, it will cause an error that dependent files cannot be found. Therefore, I think prohibiting the execution of make run under /root can solve this problem.

moonming · 2021-01-09T03:24:52Z

Makefile

 .PHONY: run
 run: default
-ifeq ("$(wildcard logs/nginx.pid)", "")
+ifeq ("$(findstring /root, ${PWD})", "/root")


We need a thorough solution, not a temporary patch

Ok, got it.

moonming · 2021-01-10T09:36:46Z

apisix/cli/ops.lua


 local function start(env, ...)
+    if env.is_root_path then
+        util.die("Error: It is forbidden to run APISIX in the /root directory.\n")


I think you don’t understand the permissions issues under Linux at all

the current way is right, but it is hard to read. @Firstsawyou please add some comment here.

any news? @Firstsawyou

A note has been added here: https://github.com/apache/apisix/pull/3220/files#diff-c25d1a2aac172147aa01feec3fa29bfe6c4625cda4773719a1cf13e67fd54da2R42

I will add more comments here later:
https://github.com/apache/apisix/pull/3220/files#diff-228a51571b53709ad043d1c6c14fc8e508c248a84f8014fe548b5d259cedd5ddR378

Cause of the bug: After APISIX is started, the worker process has the authority of nobody ordinary user. When APISIX is in the /root directory, ordinary users do not have the authority to access the /root directory. Therefore, when APISIX is started, the error log error.log will show the following error message:

init_worker_by_lua error: /root/apisix-2.1/apisix/init.lua:89: module 'resty.worker.events' not found: no field package.preload['resty.worker.events'] no file '/root/apisix-2.1//deps/share/lua/5.1/resty/worker/events.lua' no file '/root/apisix-2.1//deps/share/lua/5.1/resty/worker/events/init.lua' no file '/root/apisix-2.1/resty/worker/events.lua' no file '/root/apisix-2.1/resty/worker/events/init.lua'

any news? @Firstsawyou

updated.

membphis · 2021-01-11T12:52:23Z

t/cli/cli.t

+
+
+
+=== TEST 2: It is forbidden to run APISIX under the /root directory(is_root_path is true).


we should use shell script to test this case

membphis · 2021-01-11T12:53:42Z

apisix/cli/ops.lua


 local function start(env, ...)
+    if env.is_root_path then
+        util.die("Error: It is forbidden to run APISIX in the /root directory.\n")


the current way is right, but it is hard to read. @Firstsawyou please add some comment here.

membphis · 2021-01-12T09:28:14Z

@Firstsawyou CI failed, please fix it first

Firstsawyou · 2021-01-12T09:36:57Z

@Firstsawyou CI failed, please fix it first

Okay, I will fix it later.

membphis · 2021-01-13T02:05:03Z

apisix/cli/ops.lua


 local function start(env, ...)
+    if env.is_root_path then
+        util.die("Error: It is forbidden to run APISIX in the /root directory.\n")


any news? @Firstsawyou

membphis · 2021-01-19T01:23:19Z

ping @moonming

ccxhwmy · 2022-07-03T06:23:24Z

I think this only solves the permission problem of apisix deployed under /root, if I deploy it under /home/work1 and I use work2 as user, the problem still exists.

tzssangglass · 2022-07-04T04:21:39Z

I think this only solves the permission problem of apisix deployed under /root, if I deploy it under /home/work1 and I use work2 as user, the problem still exists.

Obviously, this PR solves the problem that APISIX runs under /root.

Please submit a new issue describing your problem.

chore: it is forbidden to execute make run in the /root directory to …

3492fc8

…run apisix. close apache#3207

spacewander reviewed Jan 8, 2021

View reviewed changes

Makefile Outdated Show resolved Hide resolved

update prompt message

ddabebe

spacewander reviewed Jan 8, 2021

View reviewed changes

Makefile Outdated Show resolved Hide resolved

non zero exit make run.

a50c375

spacewander reviewed Jan 8, 2021

View reviewed changes

moonming requested changes Jan 9, 2021

View reviewed changes

update code and test case.

8910478

moonming requested changes Jan 10, 2021

View reviewed changes

membphis requested changes Jan 11, 2021

View reviewed changes

update case.

7229f87

Firstsawyou added 6 commits January 12, 2021 18:16

fixed ci error.

fdc072b

update shell test case.

5a67a7f

update test case.

bcdbe91

update shell test case.

00f6601

update test case.

6ec2616

update test

89caf66

Firstsawyou requested review from membphis, moonming and spacewander January 13, 2021 02:00

membphis requested changes Jan 13, 2021

View reviewed changes

Firstsawyou changed the title ~~chore: it is forbidden to execute make run in the /root directory to run apisix.~~ fix: APISIX runs in the /root directory and reports errors Jan 13, 2021

add more comments.

f73f2d1

Firstsawyou requested a review from membphis January 13, 2021 03:31

spacewander approved these changes Jan 19, 2021

View reviewed changes

membphis approved these changes Jan 19, 2021

View reviewed changes

moonming approved these changes Jan 19, 2021

View reviewed changes

spacewander merged commit a815391 into apache:master Jan 19, 2021

Firstsawyou deleted the IssueNum3207 branch April 12, 2021 01:36




		=== TEST 2: It is forbidden to run APISIX under the /root directory(is_root_path is true).

fix: APISIX runs in the /root directory and reports errors #3220

fix: APISIX runs in the /root directory and reports errors #3220

Uh oh!

Conversation

Firstsawyou commented Jan 8, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What this PR does / why we need it:

Pre-submission checklist:

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Firstsawyou Jan 8, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

moonming commented Jan 9, 2021

Uh oh!

Firstsawyou commented Jan 9, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

membphis commented Jan 12, 2021

Uh oh!

Firstsawyou commented Jan 12, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

membphis commented Jan 19, 2021

Uh oh!

ccxhwmy commented Jul 3, 2022

Uh oh!

tzssangglass commented Jul 4, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

fix: APISIX runs in the `/root` directory and reports errors #3220

fix: APISIX runs in the `/root` directory and reports errors #3220

Firstsawyou commented Jan 8, 2021 •

edited

Loading

Firstsawyou Jan 8, 2021 •

edited

Loading