Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
bsmartradio committed Aug 19, 2024
1 parent e6aec2f commit 64cf278
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 5 deletions.
13 changes: 9 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,11 @@ Alert schemas are located in the ``schema`` directory.

Schemas are filed according to their version number, following a ``MAJOR.MINOR`` scheme.
We maintain ``FORWARD_TRANSITIVE`` compatibility within a major version, per the `Confluent compatibility model`_.
The latest version of the schema may always be found in ``schema/latest.txt``.
However, for all schemas to exist in the same registry this is not enforced and the schema registry compatibility is set
to ``NONE``. The latest version of the schema may always be found in ``schema/latest.txt``.

Within the schema registry, versions are registered with space for two digits in the minor version. Example : 7.1
becomes 701. Version 13.10 would be 1310.

.. _Confluent compatibility model: https://docs.confluent.io/current/schema-registry/docs/avro.html#forward-compatibility

Expand Down Expand Up @@ -68,11 +72,12 @@ Update Schema Registry

When a pull request is made for a change to ``alert_packet``, a docker container image is created which needs to be synced to
the alert stream. The new docker image is present at `lsstdm/lsst_alert_packet <https://hub.docker.com/r/lsstdm/lsst_alert_packet/tags>` on dockerhub.
The image will apear with the same tag as the ticket branch you created to update ``alert_packet``.
The image will appear with the same tag as the ticket branch you created to update ``alert_packet``.

* Go to ``alert-stream-schema-registry`` in the ``alert-stream-broker`` charts folder in the ``phalanx`` github repository.
* In the `values.yaml <https://github.com/lsst-sqre/phalanx/blob/main/applications/alert-stream-broker/charts/alert-stream-schema-registry/values.yaml>` file, update the `tag` in `schemaSync` to match the docker image tag.
* If you have access to ``argocd``, sync the ``schema-registry`` instance. If the application will not sync, a full restart may be required of the `alert-stream` application.
* In the `values.yaml <https://github.com/lsst-sqre/phalanx/blob/main/applications/alert-stream-broker/charts/alert-stream-schema-registry/values.yaml>`_ file,
update the `tag` in `schemaSync` to match the docker image tag. If the image is not updating in argo, use the image digest to force an update.
* If you have access to ``argocd``, click ``sync`` at the top. A full sync is needed to load the registry with the schemas. If the application will not sync, a full restart may be required of the `alert-stream` application.
* If you do not have access, alert whoever is in charge of the ``alert-stream`` so that they can sync the registry.

More thorough instructions for updating the schema registry can be found in `DMTN-214 <https://dmtn-214.lsst.io/#updating-the-alert-schema>`
Expand Down
2 changes: 1 addition & 1 deletion python/lsst/alert/packet/bin/syncAllSchemasToRegistry.py
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ def close_schema(registry_url, subject):

def main():
args = parse_args()
delete_schema(args.schema_registry_url,args.subject)
delete_schema(args.schema_registry_url, args.subject)
schema_registry = lsst.alert.packet.schemaRegistry.SchemaRegistry().all_schemas_from_filesystem()
upload_schema(
args.schema_registry_url,
Expand Down

0 comments on commit 64cf278

Please sign in to comment.