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.

Sign up for GitHub

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

chore: adding edit service descriptor #143

Merged
merged 3 commits into from
Jan 16, 2025
Merged

chore: adding edit service descriptor #143

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
43b21ff
chore: adding edit service descriptor
franciscolopezsancho Jan 13, 2025
2acee0c
addressing comments
franciscolopezsancho Jan 16, 2025
946b7cf
title rewritten
franciscolopezsancho Jan 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 14 additions & 5 deletions docs/src/modules/operations/pages/services/deploy-service.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ The docker build output in maven will print something similar to the following:
----
DOCKER> Tagging image shopping-cart:1.0-SNAPSHOT-20241028102843 successful!
----

[#_deploying_a_service]
== Deploying a service

Services can be deployed via the Akka CLI.
Expand Down Expand Up @@ -171,16 +171,24 @@ For further details, see xref:operations:projects/external-container-registries.
[#apply]
== Using service descriptors

Akka services can also be described and managed with *YAML service descriptors*.
Akka services can also be described and managed with *YAML service descriptors*. See xref:reference:descriptors/service-descriptor.adoc[].

Once you have <<_deploying_a_service, deployed your service>>, you can modify it by editing its service descriptor:
Copy link
Member

Choose a reason for hiding this comment

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

I think we should move this to a separate === section, after "Redeploying with a descriptor".

Edit would be a very rare operation in my opinion, unless possibly when toying around. Instead, the normal cycle is to edit the descriptor in git, then apply it again.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

OK. Let's do that.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done, now.


[source, command line]
----
akka service edit my-service
----

First, <<_build_container_image>> and then push the image:
Whether you have deployed your service or not, you can always deploy it using a service descriptor.
For this you need at least the image, which you can get by <<_build_container_image, building the container image>> and then <<_pushing_to_acr, pushing it to the container registry>>:

[source, command line]
----
akka container-registry push container-name:tag-name
----

Example of service descriptor:
Once pushed, you need to use the suggested image from the command's output in your service descriptor, for example:

[source, yaml]
----
Expand All @@ -192,7 +200,7 @@ spec:
value: some value
----

NOTE: You must add the primary region image tag. See `akka container-registry push` command's output.
NOTE: You must add the primary region image tag from `akka container-registry push` output.

To apply this descriptor, run:

Expand Down Expand Up @@ -245,3 +253,4 @@ You now know how to deploy, verify, update, and remove Akka services using the A
== Related documentation

- xref:reference:cli/akka-cli/akka_services.adoc[`akka service` CLI commands]
- xref:reference:descriptors/service-descriptor.adoc[Akka Service Descriptor]
Loading