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

Document the Local Server config options for containers #257

Open
roborourke opened this issue Jan 19, 2021 · 3 comments
Open

Document the Local Server config options for containers #257

roborourke opened this issue Jan 19, 2021 · 3 comments
Labels
developer advocacy Developer Advocacy related tasks
Milestone

Comments

@roborourke
Copy link
Contributor

After #159 went in we can now configure to some extent the containers that are set up by local server. This hasn't been documented yet so we should cover all of the options in a new page of documentation.

The key element to note here is that the other modules in Altis are not "aware" of any changes made to the configuration of this module yet so the documentation should cover the additional modifications required to prevent errors from coming up. These include:

  • XRay container
    • cloud module xray setting should be off
  • Elasticsearch container
    • search module should be off
    • analytics module "native" setting should be off
  • Kibana (no module dependencies)
  • Analytics containers
    • analytics module native setting should be off
  • Cavalcade
    • cloud module cavalcade setting should be off
@ivankristianto
Copy link
Contributor

ivankristianto commented May 25, 2021

@roborourke do you have a sample of how to use this on Travis?
For example during travis tests, we might not need:

  • mailhog
  • s3
  • xray
  • pinpoint
  • cognito
  • tachyon
  • cavalcade
  • kibana

But this setting only for CI. I wonder if we can exclude this from the composer.json?

@roborourke
Copy link
Contributor Author

I don’t think we allow for turning all of those off yet. There’s some potential crossover with needing to turn the related software off in the cloud module too.

the best way I think is to set the environment type constant returned by Altis\get_environment_type() to “ci” when you know it’s on Travis, then you use the config environment overrides with ci as the environment name.

i still need to make that an officially supported thing but I need to check everywhere we use logic that checks the environment type so nothing breaks.

@ivankristianto
Copy link
Contributor

Thanks @roborourke that make sense, let me try it on RB

@missjwo missjwo added the developer advocacy Developer Advocacy related tasks label Dec 16, 2024
@missjwo missjwo added this to the Altis v22 milestone Dec 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
developer advocacy Developer Advocacy related tasks
Projects
None yet
Development

No branches or pull requests

4 participants