-
Notifications
You must be signed in to change notification settings - Fork 3
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
Fully support service namespacing and revision tagging #529
Merged
cortadocodes
merged 95 commits into
main
from
feature/add-topic-and-subscription-creation-command
Oct 13, 2022
Merged
Fully support service namespacing and revision tagging #529
cortadocodes
merged 95 commits into
main
from
feature/add-topic-and-subscription-creation-command
Oct 13, 2022
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
BREAKING CHANGE: The `octue.services` namespace is now mandatory. Please stop providing the `namespace` argument if you were before.
BREAKING CHANGE: Provide a namespace in the service configuration (`octue.yaml`) e.g. your organisation, name, or GitHub username.
BREAKING CHANGE: Update your service IDs to follow the requirements set out in the docs.
BREAKING CHANGE: This removes the `service_id` attribute from `ServiceConfiguration` and removes the use of the `SERVICE_ID` environment variable. - **`ServiceConfiguration`:** Use `octue.cloud.service_id.create_service_id` to create IDs from `ServiceConfiguration.namespace` and `ServiceConfiguration.name` - **`SERVICE_ID` environment variable:** Use the new `OCTUE_SERVICE_NAMESPACE`, `OCTUE_SERVICE_NAME`, and `OCTUE_SERVICE_TAG` environment variables.
cortadocodes
changed the title
Resolve and fully support service namespacing
Resolve and fully support service namespacing and revision tagging
Oct 13, 2022
cortadocodes
force-pushed
the
feature/add-topic-and-subscription-creation-command
branch
from
October 13, 2022 11:26
8db9230
to
899f59b
Compare
thclark
approved these changes
Oct 13, 2022
cortadocodes
changed the title
Resolve and fully support service namespacing and revision tagging
Fully support service namespacing and revision tagging
Oct 13, 2022
cortadocodes
deleted the
feature/add-topic-and-subscription-creation-command
branch
October 13, 2022 15:06
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.
Summary
This release add support and requirement for service namespaces and service revision tags. This allows services to be versioned and provides a more familiar format for service IDs that's, for example, similar to Docker image names (e.g.
octue/example-service:latest
). Full validation of service IDs comes as part of this.The new
octue deploy create-push-subscription
has also been added as requested by users and will be accompanied by a GitHub action in another repository.Contents (#529)
IMPORTANT: There are 4 breaking changes.
New features
octue deploy create-push-subscription
CLI commandEnhancements
organisation
withnamespace
in service configurationsnamespace
parameter fromTopic
andSubscription
and applyoctue.services
Pub/Sub namespace to all topic/subscription pathsoctue.services
Pub/Sub namespace fromService
coolname
revision tag to allow a service revision with a non-unique SRUID to start as a unique service revision when using theoctue start
CLI commandService.id
attribute to the user-friendly SRUID instead of the Pub/Sub-friendly SRUIDDataflowDeployer.deploy
Fixes
Dockerfile
Operations
release
workflowDockerfile
Dependencies
setup.py
fileRefactoring
OCTUE_NAMESPACE
toOCTUE_SERVICES_NAMESPACE
id
and simplify thename
argumentUpgrade instructions
💥 Add support for and require revision tags for services
The
ServiceConfiguration.service_id
attribute and theSERVICE_ID
environment variable have been removed.ServiceConfiguration
: Useoctue.cloud.service_id.create_service_id
to create IDs fromServiceConfiguration.namespace
andServiceConfiguration.name
SERVICE_ID
environment variable: Use the newOCTUE_SERVICE_NAMESPACE
,OCTUE_SERVICE_NAME
, andOCTUE_SERVICE_REVISION_TAG
environment variables.💥 Validate service IDs before creating or questioning services
Update your services' namespaces, names, and revision tags to follow the requirements set out in the
Creating services
doc.💥 Require services to have a namespace and replace use of organisation with namespace in service configurations
Provide the
namespace
key in the service configuration (theoctue.yaml
file). If you were using theorganisation
key before, thenamespace
key now replaces it. Examples of anamespace
are your organisation's name or your GitHub username.💥 Remove namespace parameter from Topic and Subscription and apply octue.services Pub/Sub namespace to all topic/subscription paths
The
octue.services
namespace is now mandatory and applied automatically in topic and subscription paths. Please stop providing thenamespace
argument if you were providing it before.