-
Notifications
You must be signed in to change notification settings - Fork 215
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
Harmonize Envoy CLI and Configuration Files with Director Component for Consistency #1284
Open
refai06
wants to merge
14
commits into
securefederatedai:develop
Choose a base branch
from
refai06:Envoy-CLI-and-Config-cleanup
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Harmonize Envoy CLI and Configuration Files with Director Component for Consistency #1284
refai06
wants to merge
14
commits into
securefederatedai:develop
from
refai06:Envoy-CLI-and-Config-cleanup
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: refai06 <[email protected]>
Signed-off-by: refai06 <[email protected]>
Signed-off-by: refai06 <[email protected]>
Signed-off-by: refai06 <[email protected]>
Signed-off-by: refai06 <[email protected]>
Signed-off-by: refai06 <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Description:
This PR harmonizes Envoy CLI and configuration files to ensure similarity and consistency with Director component, and also introduces error handling by adding specific exceptions for Envoy configuration
Change Description:
• Updated the Envoy CLI commands by removing the
director_host
anddirector_port
parameters. These parameters (director_host
anddirector_port
) are now provided in the Envoy ConfigYAML
file.• Updated the Envoy configuration files of the Federated-Runtime workspace by including the
director_host
anddirector_port
parameters in the ConfigYAML
• This approach ensures consistency with Director component and simplifies the CLI command line
• Incorporated error handling for invalid inputs in
director_host
anddirector_port
, raising specific exceptions for invalid or missing values to improve configuration validation.Modifications:
Source Code
openfl/experimental/workflow/component/envoy/envoy.py
openfl/experimental/workflow/interface/cli/envoy.py
Tutorials
openfl-tutorials/experimental/workflow/FederatedRuntime/301_MNIST_Watermaking/Bangalore/Bangalore_config.yaml
openfl-tutorials/experimental/workflow/FederatedRuntime/301_MNIST_Watermaking/Bangalore/start_envoy.sh
openfl-tutorials/experimental/workflow/FederatedRuntime/301_MNIST_Watermaking/Chandler/Chandler_config.yaml
openfl-tutorials/experimental/workflow/FederatedRuntime/301_MNIST_Watermaking/Chandler/start_envoy.sh
openfl-tutorials/experimental/workflow/FederatedRuntime/101_MNIST/Portland/Portland_config.yaml
openfl-tutorials/experimental/workflow/FederatedRuntime/101_MNIST/Portland/start_envoy.sh
openfl-tutorials/experimental/workflow/FederatedRuntime/101_MNIST/Seattle/Seattle_config.yaml
openfl-tutorials/experimental/workflow/FederatedRuntime/101_MNIST/Seattle/start_envoy.sh
Test Cases
tests/github/experimental/workflow/FederatedRuntime/testcase_datastore_cli/envoy_one/envoy_config.yaml
tests/github/experimental/workflow/FederatedRuntime/testcase_datastore_cli/envoy_one/start_envoy.sh
tests/github/experimental/workflow/FederatedRuntime/testcase_datastore_cli/envoy_two/envoy_config.yaml
tests/github/experimental/workflow/FederatedRuntime/testcase_datastore_cli/envoy_two/start_envoy.sh
tests/github/experimental/workflow/FederatedRuntime/testcase_include_exclude/envoy_one/envoy_config.yaml
tests/github/experimental/workflow/FederatedRuntime/testcase_include_exclude/envoy_one/start_envoy.sh
tests/github/experimental/workflow/FederatedRuntime/testcase_include_exclude/envoy_two/envoy_config.yaml
tests/github/experimental/workflow/FederatedRuntime/testcase_include_exclude/envoy_two/start_envoy.sh
tests/github/experimental/workflow/FederatedRuntime/testcase_internalloop/envoy_one/envoy_config.yaml
tests/github/experimental/workflow/FederatedRuntime/testcase_internalloop/envoy_one/start_envoy.sh
tests/github/experimental/workflow/FederatedRuntime/testcase_internalloop/envoy_two/envoy_config.yaml
tests/github/experimental/workflow/FederatedRuntime/testcase_internalloop/envoy_two/start_envoy.sh
tests/github/experimental/workflow/FederatedRuntime/testcase_private_attributes/envoy_one/envoy_config.yaml
tests/github/experimental/workflow/FederatedRuntime/testcase_private_attributes/envoy_one/start_envoy.sh
tests/github/experimental/workflow/FederatedRuntime/testcase_private_attributes/envoy_two/envoy_config.yaml
tests/github/experimental/workflow/FederatedRuntime/testcase_private_attributes/envoy_two/start_envoy.sh
tests/github/experimental/workflow/FederatedRuntime/testcase_private_attributes_initialization_with_both_options/envoy_one/envoy_config.yaml
tests/github/experimental/workflow/FederatedRuntime/testcase_private_attributes_initialization_with_both_options/envoy_one/start_envoy.sh
tests/github/experimental/workflow/FederatedRuntime/testcase_private_attributes_initialization_with_both_options/envoy_two/envoy_config.yaml
tests/github/experimental/workflow/FederatedRuntime/testcase_private_attributes_initialization_with_both_options/envoy_two/start_envoy.sh
tests/github/experimental/workflow/FederatedRuntime/testcase_private_attributes_initialization_without_callable/envoy_one/envoy_config.yaml
tests/github/experimental/workflow/FederatedRuntime/testcase_private_attributes_initialization_without_callable/envoy_one/start_envoy.sh
tests/github/experimental/workflow/FederatedRuntime/testcase_private_attributes_initialization_without_callable/envoy_two/envoy_config.yaml
tests/github/experimental/workflow/FederatedRuntime/testcase_private_attributes_initialization_without_callable/envoy_two/start_envoy.sh
tests/github/experimental/workflow/FederatedRuntime/testcase_reference/envoy_one/envoy_config.yaml
tests/github/experimental/workflow/FederatedRuntime/testcase_reference/envoy_one/start_envoy.sh
tests/github/experimental/workflow/FederatedRuntime/testcase_reference/envoy_two/envoy_config.yaml
tests/github/experimental/workflow/FederatedRuntime/testcase_reference/envoy_two/start_envoy.sh
tests/github/experimental/workflow/FederatedRuntime/testcase_reference_with_include_exclude/envoy_one/envoy_config.yaml
tests/github/experimental/workflow/FederatedRuntime/testcase_reference_with_include_exclude/envoy_one/start_envoy.sh
tests/github/experimental/workflow/FederatedRuntime/testcase_reference_with_include_exclude/envoy_two/envoy_config.yaml
tests/github/experimental/workflow/FederatedRuntime/testcase_reference_with_include_exclude/envoy_two/start_envoy.sh
tests/github/experimental/workflow/FederatedRuntime/testcase_subset_of_collaborators/envoy_four/envoy_config.yaml
tests/github/experimental/workflow/FederatedRuntime/testcase_subset_of_collaborators/envoy_four/start_envoy.sh
tests/github/experimental/workflow/FederatedRuntime/testcase_subset_of_collaborators/envoy_one/envoy_config.yaml
tests/github/experimental/workflow/FederatedRuntime/testcase_subset_of_collaborators/envoy_one/start_envoy.sh
tests/github/experimental/workflow/FederatedRuntime/testcase_subset_of_collaborators/envoy_three/envoy_config.yaml
tests/github/experimental/workflow/FederatedRuntime/testcase_subset_of_collaborators/envoy_three/start_envoy.sh
tests/github/experimental/workflow/FederatedRuntime/testcase_subset_of_collaborators/envoy_two/envoy_config.yaml
tests/github/experimental/workflow/FederatedRuntime/testcase_subset_of_collaborators/envoy_two/start_envoy.sh
Documentation
docs/about/features_index/workflowinterface.rst
Validation:
Executed following tutorials to ensure that the change is working properly:
openfl-tutorials/experimental/workflow/FederatedRuntime/101_MNIST
openfl-tutorials/experimental/workflow/FederatedRuntime/301_MNIST_Watermaking