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

re-organize scripts to make end-user actions easier to find #204

Merged
merged 15 commits into from
May 12, 2021

Conversation

glennmusa
Copy link
Contributor

@glennmusa glennmusa commented May 11, 2021

Description

This change proposes to reorganize the repository to make the end-user scripts and configuration files easier to identify.

Proposed source organization

With this proposal, /src/scripts contains the three scripts we expect end users to invoke and the rest of the implementation is organized under src/scripts/*:

└──missionlz
  └──src
    └──scripts
      clean.sh
      deploy.sh
      deploy_ui.sh
      └──config
      └──container-registry
      └──docker
      └──security-center
      └──terraform
      └──util

Proposed name changes

This change also propose these name changes:

current name proposed name what the value represents
mlz_tf_cfg.var mlz.config a file that contains key-value pairs that dictate how MLZ configuration resources are deployed
mlz_tf_setup.sh create_mlz_configuration_resources.sh a script that deploys MLZ configuration resources by reading the above file
setup_ezdeploy.sh deploy_ui.sh a script that deploys the MLZ front-end application to Azure Container Registry
setup_ezdeploy_local.sh deploy_ui_local.sh a script that deploys the MLZ front-end application locally

Issue reference

The issue this PR will close: #166

Checklist

Please make sure you've completed the relevant tasks for this PR, out of the following list:

  • Code compiles or validates correctly
  • BASH scripts have been validated using shellcheck
  • All tests pass (manual and automated)
  • The documentation is updated to cover any new or changed features
  • Markdown files have been linted using the recommended linter. (See .vscode/extensions.json.)
  • Relevant issues are linked to this PR

@Phydeauxman
Copy link
Contributor

I am fine with these changes...they make sense. Can we use this as an opportunity to move the scripts that are in /src into the /src/scripts folder?

@glennmusa
Copy link
Contributor Author

I am fine with these changes...they make sense. Can we use this as an opportunity to move the scripts that are in /src into the /src/scripts folder?

Yeah we can do that -- will need to update docs on how to find them

Copy link
Contributor

@Breanna-Stryker Breanna-Stryker left a comment

Choose a reason for hiding this comment

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

This all looks good to me as well.

@glennmusa
Copy link
Contributor Author

Cool! Thanks everyone. Moving deploy and clean to src/scripts so that it's packaged with the air-gapped and UI container, will merge once that is complete. 👍

@glennmusa glennmusa merged commit 9030bc9 into main May 12, 2021
@glennmusa glennmusa deleted the glenn/cleandeploy branch May 12, 2021 17:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

End-user facing scripts should be easily identifiable
3 participants