Homebrew Repo for bc-local cask. Launch and run BriteCore Locally 🛳️
Note: Since this is a homebrew cask there is no need to clone this repository. You just need to have homebrew installed!
brew tap intuitivewebsolutions/bc-local
brew install bc-local
export BRITECORE_CODE_DIR=<path/to/britecore/code/dir>
mkdir -p ~/bc-local-data-load
export BRITECORE_DATA_LOAD_DIR=~/bc-local-data-load
export KIND_EXPERIMENTAL_PROVIDER=podman
export AWS_PROFILE=<profile_name> && aws sso login --profile <profile_name> # Replace <profile_name> with a profile from ~/.aws/configAdd the export statements to the bottom of your ~/.zshrc if you'd like these to be initialized in any new terminal session
Warning
Make sure that your Podman setup has enough resources allocated (≥ 8GB memory) to it in order to run a BriteCore site. You can use the following command to automatically use recommended settings podman machine init podman-machine-default --cpus 8 --memory 8192 --disk-size 100 --now.
This will launch a local britecore site from scratch:
bc-local bootstrap client=rowanmutual celery=false pytest=false #change args as needed
bc-local status
bc-local open webThe site is available once the web pod (seen using bc-local status) is Running all containers.
bc-local refreshMake updates to the BriteCore code in the directory specified at $BRITECORE_CODE_DIR then run bc-local refresh
bc-local monitoringbrew update && brew upgrade bc-localbrew install bc-local-beta
bc-local-beta versionbc-local-beta is where we will push the latest features and changes that have been merged to the main source code branch.
Click to expand solution
You'll encounter this error if your profile isn't configured in your ~/.aws/config file. You can use the following profile or model a custom profile based on the one below. If you use the profile below, you can retry the authentication process using export AWS_PROFILE=bcp_engineer && aws sso login --profile bcp_engineer
[profile bcp_engineer]
region = us-east-1
cli_auto_prompt = on-partial
sso_start_url = https://britecore-accounts.awsapps.com/start#/
sso_region = us-east-1
sso_account_id = 313750358190
sso_role_name = BriteCoreProEngineer
duration_seconds = 14400
output = textClick to expand solution
Example terminal error
This problem typically is due to the podman VM setup not properly creating necessary connections. You can validate the issue by running `podman system connection list` not getting any output.
To fix you'll want to run the following
podman machine init
podman machine startThen you should see output upon rerun of podman system connection list
Click to expand solution
Example terminal error
If you're seeing this and you are able to see the image locally when executing the following
podman images | grep localhost/bc-local/webyou can fix by running
sudo ln -sf "$(command -v podman)" /usr/local/bin/dockerClick to expand solution
If you're seeing many error logs related to the DataDog Agent, it's typically because it's unable to find the bc-local monitoring stack. You can resolve this by launching the monitoring stackbc-local monitoringClick to expand solution
Example VS Code error popup
If you see this error when attempting to connect to the debugger port, this may be because the bc-local kind cluster is not exposing the port.
You can test this by executing
lsof -i TCP |grep 30678which should provide an output like
gvproxy ... TCP *:30678 (LISTEN)If you get no output then run the following to fix:
bc-local clean
bc-local bootstrap
