Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[bitnami/apisix] Fixes to support running Apisix in standalone mode #27062

Merged
merged 10 commits into from
Jun 20, 2024

Conversation

james-mchugh
Copy link
Contributor

Description of the change

Updates the _helpers.tpl file to disable the addition of control-plane environment variables to the apisix.renderConfInitContainer and apisix.prepareApisixInitContainer templates when the control plane is disabled. As these environment variables are sourced from secrets, they cause the init containers to fail if the secrets do not exist.

Updates the defaultConfig in the Values.yaml so the etcd configs are removed if etcd is disabled and no external etcd servers are set.

Updates the standalone instructions in the README.md to include the disabling of the dashboard, adding the #END line to the end of the example config, and updating the config path to be mounted at the path Apisix expects the config file to be at (/usr/local/apisix/conf/apisix.yaml).

Benefits

Apisix standalone mode should now work when following the instructions in the README.

Possible drawbacks

Unexpected impacts to other deployment modes. The changes are pretty minor though, and should have minimal risk of impacting other modes.

Applicable issues

Additional information

Checklist

  • Chart version bumped in Chart.yaml according to semver. This is not necessary when the changes only affect README.md files.
  • Variables are documented in the values.yaml and added to the README.md using readme-generator-for-helm
  • Title of the pull request follows this pattern [bitnami/<name_of_the_chart>] Descriptive title
  • All commits signed off and in agreement of Developer Certificate of Origin (DCO)

Signed-off-by: James Riley McHugh <mchugh_james@bah.com>
@github-actions github-actions bot added apisix triage Triage is needed labels Jun 8, 2024
@github-actions github-actions bot requested a review from javsalgar June 8, 2024 03:52
James Riley McHugh and others added 2 commits June 7, 2024 23:53
Signed-off-by: James Riley McHugh <mchugh_james@bah.com>
Signed-off-by: Bitnami Containers <bitnami-bot@vmware.com>
@carrodher carrodher added verify Execute verification workflow for these changes in-progress labels Jun 9, 2024
@github-actions github-actions bot removed the triage Triage is needed label Jun 9, 2024
@github-actions github-actions bot removed the request for review from javsalgar June 9, 2024 11:42
@github-actions github-actions bot requested a review from jotamartos June 9, 2024 11:42
Signed-off-by: Bitnami Containers <bitnami-bot@vmware.com>
Copy link
Contributor

@jotamartos jotamartos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes LGTM but please undo the change I mentioned in my comment

bitnami/apisix/README.md Show resolved Hide resolved
James Riley McHugh added 2 commits June 17, 2024 17:16
…dalone-mode

# Conflicts:
#	bitnami/apisix/CHANGELOG.md
#	bitnami/apisix/Chart.lock
Signed-off-by: James Riley McHugh <mchugh_james@bah.com>
@james-mchugh
Copy link
Contributor Author

james-mchugh commented Jun 17, 2024

Hello @jotamartos. I fixed the merge conflicts and responded to your request. Please let me know if there is anything additional needed.

bitnami-bot and others added 4 commits June 17, 2024 21:19
Signed-off-by: Bitnami Containers <bitnami-bot@vmware.com>
…dalone-mode

# Conflicts:
#	bitnami/apisix/CHANGELOG.md
#	bitnami/apisix/Chart.lock
Signed-off-by: James Riley McHugh <mchugh_james@bah.com>
Signed-off-by: Bitnami Containers <bitnami-bot@vmware.com>
@jotamartos
Copy link
Contributor

Sorry for the delay here. I added more information about why the symlink is lost. Would you mind updating the logic and the PR so everyone can benefit from the change?

Thanks

@jotamartos jotamartos merged commit 272a58e into bitnami:main Jun 20, 2024
17 checks passed
@jotamartos
Copy link
Contributor

As a final note, the symlink is lost because we are mounting an empty volume to follow best security practices. There are many references to /usr/local/apisix in the code so we will keep the suggested changes and revisit the symlink configuration in the future.

@james-mchugh
Copy link
Contributor Author

@jotamartos Thank you for reviewing and approving my PR!

@james-mchugh james-mchugh deleted the fix-apisix-standalone-mode branch June 20, 2024 13:34
@vivekhegadems
Copy link

Please provide the timeline on when the next release of apisix will happen from bitnami with this standalone deployment fix?

@carrodher
Copy link
Member

The new version was released right after the PR was merged, see https://hub.docker.com/layers/bitnamicharts/apisix/3.2.5/images/sha256-b52d44638bc1cc71ff9656a4073fe3878d955ef5f2c087e57a41c439157e1e55?context=explore

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
apisix solved verify Execute verification workflow for these changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[bitnami/apisix] Standalone Mode Not Working
7 participants