fix: avoid config.yaml modification in standalone mode due to read only file system.

[TheShubhendra]

• Removed modification of config.yaml in standalone mode.
• Added checks to make sure it uses data plane with yaml config provider.
• Added separate config file for standalone mode example.

[TheShubhendra]

This PR will close #541 , #547 and #557 .

[TheShubhendra]

Can you please review @kayx23

[shreemaan-abhishek]

the CI is not running, please push an empty commit

[TheShubhendra]

the CI is not running, please push an empty commit

@shreemaan-abhishek I have pushed an empty commit but CI is still not running.

[TheShubhendra]

I had tested workflow apisix dashboard all in one docker on my local system, it works fine after 2ef539f .
So I had modified the workflow file in my fork that shows it is not able to run the container to due to segmentation fault as mentioned in this job run https://github.com/TheShubhendra/apisix-docker/actions/runs/10062135660/job/27813891259 .

[TheShubhendra]

Can someone please review?

[shreemaan-abhishek]

@TheShubhendra, please check why is the dashboard CI failing. Thank you for your patience.

[TheShubhendra]

@TheShubhendra, please check why is the dashboard CI failing. Thank you for your patience.

As I mentioned before, the same workflow works on my PC, but it gives a segmentation fault on GitHub Actions. https://github.com/TheShubhendra/apisix-docker/actions/runs/10062135660/job/27813891259#:~:text=Segmentation%20fault%20(core%20dumped) This could be due to GitHub's resource limits or possibly another issue not related to apisix, I suppose?

[kayx23]

Re-running failed jobs.

[TheShubhendra]

Why all actions are now failing with the same reason docker-compose: command not found

[TheShubhendra]

This issue seems to be from the main APISIX source code, not this repository.

Edit: My bad it uses local Dockerfile to build

[shreemaan-abhishek]

@TheShubhendra, thanks for the fix. Please make this fix in another PR and then pull changes from master when the fix PR is merged. One PR for one thing. Thanks for your patience.

[shreemaan-abhishek]

@TheShubhendra, please merge master branch to pull the fix.

[shreemaan-abhishek]

this part of code is being repeated across entrypoint scripts. Please DRY.

[TheShubhendra]

Thank you for your suggestion. What we can do is extract the logic into a single file and place it in the root directory. Then, we can modify the Makefile to copy this file into the appropriate build context directories (e.g., /debian, /redhat, and /debian-dev) before the Docker build process, and remove it afterward.

Please share your thoughts on this.

[TheShubhendra]

#!/bin/bash

check_config() {
    local key="$1"
    local expected_value="$2"
    local error_message="$3"

    if ! grep -q "${key}: ${expected_value}" "${PREFIX}/conf/config.yaml"; then
        echo "Error: ${PREFIX}/conf/config.yaml does not contain '${key}: ${expected_value}'. ${error_message}"
        echo "Please refer to the APISIX documentation for deployment modes: https://apisix.apache.org/docs/apisix/deployment-modes/"
        exit 1
    fi
}

check_config "role" "data_plane" "Deployment role must be set to 'data_plane' for standalone mode."
check_config "role_data_plane" "" "Role must be set to 'role_data_plane:' for standalone mode."
check_config "config_provider" "yaml" "Config provider must be set to 'yaml' for standalone mode."

This file can be placed into /utils and then sourced into all entrypoint files.

[shreemaan-abhishek]

yes

[TheShubhendra]

can someone please review this PR

[github-actions]

This pull request has been marked as stale due to 60 days of inactivity. It will be closed in 4 weeks if no further activity occurs. If you think that's incorrect or this pull request should instead be reviewed, please simply write any comment. Even if closed, you can still revive the PR at any time ordiscuss it on the [email protected] list. Thank you for your contributions.

[TheShubhendra]

Any updates on this?

[hiddenmarten]

I would like to vote on this PR, it's really helpful and solves a lot of confusing issues in the current repository state.