SMQ-2533 - Rename Magistrala to SuperMQ #2560

dborovcanin · 2024-12-02T15:14:25Z

What type of PR is this?

What does this do?

This is a renaming PR that renames code references and naming.

Which issue(s) does this PR fix/relate to?

Resolves #2533

Have you included tests for your changes?

No.

Did you document any new/modified feature?

N/A

Notes

N/A

arvindh123 · 2024-12-02T15:59:59Z

clients/service.go

-	svcerr "github.com/absmach/magistrala/pkg/errors/service"
-	"github.com/absmach/magistrala/pkg/policies"
-	"github.com/absmach/magistrala/pkg/roles"
+	mg "github.com/absmach/supermq"


Suggested change

mg "github.com/absmach/supermq"

smq "github.com/absmach/supermq"

arvindh123 · 2024-12-02T16:00:14Z

clients/service.go

-	"github.com/absmach/magistrala/pkg/roles"
+	mg "github.com/absmach/supermq"
+	mgauth "github.com/absmach/supermq/auth"
+	grpcChannelsV1 "github.com/absmach/supermq/internal/grpc/channels/v1"


Instead of mgauth can we have like smqAuth ?

smqAuth "github.com/absmach/supermq/auth"

arvindh123 · 2024-12-02T16:00:49Z

clients/api/http/clients.go

+	"github.com/absmach/supermq/internal/api"
+	"github.com/absmach/supermq/pkg/apiutil"
+	mgauthn "github.com/absmach/supermq/pkg/authn"
+	roleManagerHttp "github.com/absmach/supermq/pkg/roles/rolemanager/api"


Instead of mgauthn can we have like smqAuthn ?

smqAuthn "github.com/absmach/supermq/pkg/authn"

arvindh123 · 2024-12-02T16:01:05Z

clients/api/http/endpoints_test.go

+	"github.com/absmach/supermq/internal/api"
+	"github.com/absmach/supermq/internal/testsutil"
+	mglog "github.com/absmach/supermq/logger"
+	"github.com/absmach/supermq/pkg/apiutil"


Instead of mglog can we have like smqLog ?

smqLog "github.com/absmach/supermq/logger"

arvindh123 · 2024-12-02T16:01:18Z

clients/api/http/endpoints_test.go

+	mglog "github.com/absmach/supermq/logger"
+	"github.com/absmach/supermq/pkg/apiutil"
+	mgauthn "github.com/absmach/supermq/pkg/authn"
+	authnmocks "github.com/absmach/supermq/pkg/authn/mocks"


Instead of mgauthn can we have like smqAuthn ?

smqAuthn "github.com/absmach/supermq/pkg/authn"

arvindh123 · 2024-12-02T16:01:35Z

cmd/clients/main.go

+	mglog "github.com/absmach/supermq/logger"
+	authsvcAuthn "github.com/absmach/supermq/pkg/authn/authsvc"
+	mgauthz "github.com/absmach/supermq/pkg/authz"
+	authsvcAuthz "github.com/absmach/supermq/pkg/authz/authsvc"


Instead of mgauthz can we have like smqAuthz ?

smqAuthz "github.com/absmach/supermq/pkg/authz"

arvindh123 · 2024-12-02T16:07:06Z

.github/PULL_REQUEST_TEMPLATE.md

@@ -4,7 +4,7 @@ SPDX-License-Identifier: Apache-2.0 -->
 <!--

 Pull request title should be `MG-XXX - description` or `NOISSUE - description` where XXX is ID of the issue that this PR relate to.
-Please review the [CONTRIBUTING.md](https://github.com/absmach/magistrala/blob/main/CONTRIBUTING.md) file for detailed contributing guidelines.
+Please review the [CONTRIBUTING.md](https://github.com/absmach/supermq/blob/main/CONTRIBUTING.md) file for detailed contributing guidelines.


Suggested change

Please review the [CONTRIBUTING.md](https://github.com/absmach/supermq/blob/main/CONTRIBUTING.md) file for detailed contributing guidelines.

Pull request title should be `SMQ-XXX - description` or `NOISSUE - description` where XXX is ID of the issue that this PR relate to.

arvindh123

At here
https://github.com/dborovcanin/supermq/blob/08aa508698b4f36ddfee47296fd0b0114e71eb41/CONTRIBUTING.md#L56
Please change to

Create a new topic branch from `master` using the naming convention `SMQ-[issue-number]`

At here
https://github.com/dborovcanin/supermq/blob/08aa508698b4f36ddfee47296fd0b0114e71eb41/CONTRIBUTING.md#L60
Please change to

git checkout -b SMQ-[issue-number]

At here
https://github.com/dborovcanin/supermq/blob/08aa508698b4f36ddfee47296fd0b0114e71eb41/CONTRIBUTING.md#L83
Please change to

git push origin SMQ-[issue-number]

At here
https://github.com/dborovcanin/supermq/blob/08aa508698b4f36ddfee47296fd0b0114e71eb41/docker/ssl/Makefile#L33-L38
we have words magistrala and mg

arvindh123 · 2024-12-02T16:11:12Z

channels/service_test.go

+	"github.com/absmach/supermq/channels/mocks"
+	"github.com/absmach/supermq/clients"
+	mgclients "github.com/absmach/supermq/clients"
+	clmocks "github.com/absmach/supermq/clients/mocks"


Instead of mgclient can we have smqClients?

smqclients "github.com/absmach/supermq/clients"

arvindh123 · 2024-12-02T16:11:25Z

channels/service.go

-	"github.com/absmach/magistrala/pkg/roles"
+	"github.com/absmach/supermq"
+	mgclients "github.com/absmach/supermq/clients"
+	grpcClientsV1 "github.com/absmach/supermq/internal/grpc/clients/v1"


Instead of mgclient can we have smqClients?

smqClients "github.com/absmach/supermq/clients"

arvindh123 · 2024-12-02T16:16:59Z

consumers/writers/postgres/consumer.go

-	"github.com/absmach/magistrala/pkg/transformers/senml"
+	"github.com/absmach/supermq/consumers"
+	"github.com/absmach/supermq/pkg/errors"
+	mgjson "github.com/absmach/supermq/pkg/transformers/json"


Suggested change

mgjson "github.com/absmach/supermq/pkg/transformers/json"

smqJson "github.com/absmach/supermq/pkg/transformers/json"

arvindh123 · 2024-12-02T16:17:55Z

channels/api/http/endpoint_test.go

+	"github.com/absmach/supermq/channels/mocks"
+	"github.com/absmach/supermq/clients"
+	mgapi "github.com/absmach/supermq/internal/api"
+	"github.com/absmach/supermq/internal/testsutil"


Instead of mgapi can we have like smqAPI ?

smqAPI "github.com/absmach/supermq/internal/api"

arvindh123

At here https://github.com/dborovcanin/supermq/blob/b27d924d8289155e1199a7f26567988a8b589699/.github/workflows/swagger-ui.yaml#L31
We need to change to docs.api.magistrala.abstractmachines.fr

At here following places

we need to change from @magistrala.com to @supermq.com or even better @example.com

At following places we need to chagne the docker image tag to supermq

https://github.com/dborovcanin/supermq/blob/08aa508698b4f36ddfee47296fd0b0114e71eb41/docker/docker-compose.yml#L1152 ( for vernemq i think we can have supermq)
https://github.com/dborovcanin/supermq/blob/08aa508698b4f36ddfee47296fd0b0114e71eb41/docker/docker-compose.yml#L1182 (not sure about here)
In docker/ssl/Makfile https://github.com/dborovcanin/supermq/blob/08aa508698b4f36ddfee47296fd0b0114e71eb41/docker/ssl/Makefile#L37-L38 we need to change to SuperMQ
At here https://github.com/dborovcanin/supermq/blob/4732ddb596e21c7e84aedf31d7dd8a96c37a0b1c/http/README.md#L71 i think docs link should be changed to supermq

arvindh123 · 2024-12-02T16:24:03Z

groups/postgres/groups.go

-	repoerr "github.com/absmach/magistrala/pkg/errors/repository"
-	"github.com/absmach/magistrala/pkg/postgres"
-	rolesPostgres "github.com/absmach/magistrala/pkg/roles/repo/postgres"
+	mggroups "github.com/absmach/supermq/groups"


Suggested change

mggroups "github.com/absmach/supermq/groups"

smqGroups "github.com/absmach/supermq/groups"

arvindh123 · 2024-12-03T12:14:45Z

users/README.md


-Setting `MG_AUTH_GRPC_CLIENT_CERT` and `MG_AUTH_GRPC_CLIENT_KEY` will enable TLS against the auth service. The service expects a file in PEM format for both the certificate and the key. Setting `MG_AUTH_GRPC_SERVER_CA_CERTS` will enable TLS against the auth service trusting only those CAs that are provided. The service expects a file in PEM format of trusted CAs.
+Setting `SMQ_AUTH_GRPC_CLIENT_CERT` and `SMQ_AUTH_GRPC_CLIENT_KEY` will enable TLS against the auth service. The service expects a file in PEM format for both the certificate and the key. Setting `SMQ_AUTH_GRPC_SERVER_CA_CERTS` will enable TLS against the auth service trusting only those CAs that are provided. The service expects a file in PEM format of trusted CAs.

 ## Usage

 For more information about service capabilities and its usage, please check out the [API documentation](https://docs.api.magistrala.abstractmachines.fr/?urls.primaryName=users-openapi.yml).


Suggested change

For more information about service capabilities and its usage, please check out the [API documentation](https://docs.api.magistrala.abstractmachines.fr/?urls.primaryName=users-openapi.yml).

For more information about service capabilities and its usage, please check out the [API documentation](https://docs.api.supermq.abstractmachines.fr/?urls.primaryName=users-openapi.yml).

arvindh123 · 2024-12-03T12:15:56Z

auth/README.md

-Setting `MG_AUTH_HTTP_SERVER_CERT` and `MG_AUTH_HTTP_SERVER_KEY` will enable TLS against the service. The service expects a file in PEM format for both the certificate and the key.
-Setting `MG_AUTH_GRPC_SERVER_CERT` and `MG_AUTH_GRPC_SERVER_KEY` will enable TLS against the service. The service expects a file in PEM format for both the certificate and the key. Setting `MG_AUTH_GRPC_SERVER_CA_CERTS` will enable TLS against the service trusting only those CAs that are provided. The service expects a file in PEM format of trusted CAs. Setting `MG_AUTH_GRPC_CLIENT_CA_CERTS` will enable TLS against the service trusting only those CAs that are provided. The service expects a file in PEM format of trusted CAs.
+Setting `SMQ_AUTH_HTTP_SERVER_CERT` and `SMQ_AUTH_HTTP_SERVER_KEY` will enable TLS against the service. The service expects a file in PEM format for both the certificate and the key.
+Setting `SMQ_AUTH_GRPC_SERVER_CERT` and `SMQ_AUTH_GRPC_SERVER_KEY` will enable TLS against the service. The service expects a file in PEM format for both the certificate and the key. Setting `SMQ_AUTH_GRPC_SERVER_CA_CERTS` will enable TLS against the service trusting only those CAs that are provided. The service expects a file in PEM format of trusted CAs. Setting `SMQ_AUTH_GRPC_CLIENT_CA_CERTS` will enable TLS against the service trusting only those CAs that are provided. The service expects a file in PEM format of trusted CAs.

 ## Usage

 For more information about service capabilities and its usage, please check out the [API documentation](https://docs.api.magistrala.abstractmachines.fr/?urls.primaryName=auth.yml).


Suggested change

For more information about service capabilities and its usage, please check out the [API documentation](https://docs.api.magistrala.abstractmachines.fr/?urls.primaryName=auth.yml).

For more information about service capabilities and its usage, please check out the [API documentation](https://docs.api.supermq.abstractmachines.fr/?urls.primaryName=auth.yml).

arvindh123 · 2024-12-03T12:24:18Z

api/openapi/README.md


-This folder contains an OpenAPI specifications for Magistrala API.
+This folder contains an OpenAPI specifications for SuperMQ API.

 View specification in Swagger UI at [docs.api.magistrala.abstractmachines.fr](https://docs.api.magistrala.abstractmachines.fr)


Suggested change

View specification in Swagger UI at [docs.api.magistrala.abstractmachines.fr](https://docs.api.magistrala.abstractmachines.fr)

View specification in Swagger UI at [docs.api.supermq.abstractmachines.fr](https://docs.api.supermq.abstractmachines.fr)

arvindh123 · 2024-12-03T12:28:12Z

CONTRIBUTING.md


-The following is a set of guidelines to contribute to Magistrala and its libraries, which are
+The following is a set of guidelines to contribute to SuperMQ and its libraries, which are
 hosted on the [Abstract Machines Organization](https://github.com/absmach) on GitHub.

 This project adheres to the [Contributor Covenant 1.2](http://contributor-covenant.org/version/1/2/0).


I think we don't have domain magistrala.com, if it is true, then we need to rename @magistrala.com to @abstractmachines.fr
I

arvindh123 · 2024-12-03T12:30:55Z

cli/README.md

@@ -15,79 +15,79 @@ make cli
 #### Get Magistrala Services Health Check


Suggested change

#### Get Magistrala Services Health Check

#### Get SuperMQ Services Health Check

Same we need in top of the file

arvindh123 · 2024-12-03T12:31:11Z

clients/README.md

@@ -119,4 +119,4 @@ To run service in a standalone mode, set `Clients_STANDALONE_EMAIL` and `Clients
 For more information about service capabilities and its usage, please check out
 the [API documentation](https://docs.api.magistrala.abstractmachines.fr/?urls.primaryName=clients-openapi.yml).


Suggested change

the [API documentation](https://docs.api.magistrala.abstractmachines.fr/?urls.primaryName=clients-openapi.yml).

the [API documentation](https://docs.api.supermq.abstractmachines.fr/?urls.primaryName=clients-openapi.yml).

arvindh123 · 2024-12-03T12:31:48Z

coap/README.md


 Running this service outside of container requires working instance of the message broker service, clients service and Jaeger server.
 To start the service outside of the container, execute the following shell script:

 ```bash
 # download the latest version of the service
-git clone https://github.com/absmach/magistrala
+git clone https://github.com/absmach/supermq


If we are moving to magistrala repo then it should be

Suggested change

git clone https://github.com/absmach/supermq

git clone https://github.com/absmach/magistrala

arvindh123 · 2024-12-03T12:36:11Z

consumers/README.md

 be transformed into any valid format that specific consumer can understand. For example,
 writers are consumers that can take a SenML or JSON message and store it.

 Consumers are optional services and are treated as plugins. In order to
 run consumer services, core services must be up and running.

 For an in-depth explanation of the usage of `consumers`, as well as thorough
-understanding of Magistrala, please check out the [official documentation][doc].
+understanding of SuperMQ, please check out the [official documentation][doc].

 For more information about service capabilities and its usage, please check out
 the [API documentation](https://docs.api.magistrala.abstractmachines.fr/?urls.primaryName=consumers-notifiers-openapi.yml).


Suggested change

the [API documentation](https://docs.api.magistrala.abstractmachines.fr/?urls.primaryName=consumers-notifiers-openapi.yml).

the [API documentation](https://docs.api.supermq.abstractmachines.fr/?urls.primaryName=consumers-notifiers-openapi.yml).

arvindh123 · 2024-12-03T12:42:29Z

bootstrap/README.md

@@ -1,31 +1,31 @@
 # BOOTSTRAP SERVICE


Since bootstrap service will be in MG, we can revert the words to Magistrala in valid places

arvindh123 · 2024-12-03T12:43:19Z

certs/README.md

@@ -1,23 +1,23 @@
 # Certs Service


Since certs service is going to be in Magistrala, we can change word SuperMQ to Magistrala in valid places

We will probably keep certs as a part of IAM for SMQ.

Signed-off-by: Dusan Borovcanin <borovcanindusan1@gmail.com>

arvindh123 · 2024-12-04T07:57:02Z

tools/mqtt-bench/bench.go

 	if err != nil {
 		return fmt.Errorf("error loading connections file: %s", err)
 	}

-	mg := magistrala{}
+	mg := superMQ{}


please change mg to smq

In this same file we have word mgChan and mgCli

Signed-off-by: Dusan Borovcanin <borovcanindusan1@gmail.com>

dborovcanin force-pushed the rename branch 2 times, most recently from 68bf085 to f2d6260 Compare December 2, 2024 15:21

arvindh123 requested changes Dec 2, 2024

View reviewed changes

arvindh123 reviewed Dec 2, 2024

View reviewed changes

arvindh123 requested changes Dec 2, 2024

View reviewed changes

arvindh123 reviewed Dec 2, 2024

View reviewed changes

arvindh123 requested changes Dec 3, 2024

View reviewed changes

arvindh123 reviewed Dec 3, 2024

View reviewed changes

dborovcanin force-pushed the rename branch 3 times, most recently from 9d1e898 to eb15329 Compare December 3, 2024 16:12

dborovcanin force-pushed the main branch from 252113a to 10bc218 Compare December 3, 2024 16:18

dborovcanin added 8 commits December 3, 2024 17:19

Rename module and imports

c0fbef0

Signed-off-by: Dusan Borovcanin <borovcanindusan1@gmail.com>

Rename package and imports

11910c9

Signed-off-by: Dusan Borovcanin <borovcanindusan1@gmail.com>

Rename comments and streams

ccb941d

Signed-off-by: Dusan Borovcanin <borovcanindusan1@gmail.com>

Fix CODEOWNERS

b70f900

Signed-off-by: Dusan Borovcanin <borovcanindusan1@gmail.com>

Rename server certificate

882dfe5

Signed-off-by: Dusan Borovcanin <borovcanindusan1@gmail.com>

Update CONTRIBUTING file

2a3b0a8

Signed-off-by: Dusan Borovcanin <borovcanindusan1@gmail.com>

Update docs link

02138e3

Signed-off-by: Dusan Borovcanin <borovcanindusan1@gmail.com>

E859

Fix PR remarks

8498f64

Signed-off-by: Dusan Borovcanin <borovcanindusan1@gmail.com>

dborovcanin force-pushed the rename branch from eb15329 to 8498f64 Compare December 3, 2024 16:19

dborovcanin added 2 commits December 3, 2024 17:27

Rename MQTT image

d3e3e22

Signed-off-by: Dusan Borovcanin <borovcanindusan1@gmail.com>

Fix remarks for import aliases

a5011c3

Signed-off-by: Dusan Borovcanin <borovcanindusan1@gmail.com>

dborovcanin force-pushed the rename branch from 99e3a8f to a5011c3 Compare December 3, 2024 16:38

Update import aliases and CLI README

47c9b09

Signed-off-by: Dusan Borovcanin <borovcanindusan1@gmail.com>

dborovcanin force-pushed the rename branch from e0d1a90 to 47c9b09 Compare December 3, 2024 18:15

arvindh123 requested changes Dec 4, 2024

View reviewed changes

dborovcanin merged commit 178aa46 into absmach:main Dec 4, 2024
6 of 7 checks passed

dborovcanin deleted the rename branch December 4, 2024 10:17

felixgateru pushed a commit to felixgateru/supermq that referenced this pull request Dec 5, 2024

SMQ-2533 - Rename Magistrala to SuperMQ (absmach#2560)

4c71a8d

Signed-off-by: Dusan Borovcanin <borovcanindusan1@gmail.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

SMQ-2533 - Rename Magistrala to SuperMQ #2560

SMQ-2533 - Rename Magistrala to SuperMQ #2560

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

	mg "github.com/absmach/supermq"
	smq "github.com/absmach/supermq"

	Please review the [CONTRIBUTING.md](https://github.com/absmach/supermq/blob/main/CONTRIBUTING.md) file for detailed contributing guidelines.
	Pull request title should be `SMQ-XXX - description` or `NOISSUE - description` where XXX is ID of the issue that this PR relate to.

	mgjson "github.com/absmach/supermq/pkg/transformers/json"
	smqJson "github.com/absmach/supermq/pkg/transformers/json"

	mggroups "github.com/absmach/supermq/groups"
	smqGroups "github.com/absmach/supermq/groups"

	For more information about service capabilities and its usage, please check out the [API documentation](https://docs.api.magistrala.abstractmachines.fr/?urls.primaryName=users-openapi.yml).
	For more information about service capabilities and its usage, please check out the [API documentation](https://docs.api.supermq.abstractmachines.fr/?urls.primaryName=users-openapi.yml).

	View specification in Swagger UI at [docs.api.magistrala.abstractmachines.fr](https://docs.api.magistrala.abstractmachines.fr)
	View specification in Swagger UI at [docs.api.supermq.abstractmachines.fr](https://docs.api.supermq.abstractmachines.fr)

		@@ -15,79 +15,79 @@ make cli
		#### Get Magistrala Services Health Check

	#### Get Magistrala Services Health Check
	#### Get SuperMQ Services Health Check

		@@ -119,4 +119,4 @@ To run service in a standalone mode, set `Clients_STANDALONE_EMAIL` and `Clients
		For more information about service capabilities and its usage, please check out
		the [API documentation](https://docs.api.magistrala.abstractmachines.fr/?urls.primaryName=clients-openapi.yml).

	git clone https://github.com/absmach/supermq
	git clone https://github.com/absmach/magistrala

SMQ-2533 - Rename Magistrala to SuperMQ #2560

SMQ-2533 - Rename Magistrala to SuperMQ #2560

Uh oh!

Conversation

What type of PR is this?

What does this do?

Which issue(s) does this PR fix/relate to?

Have you included tests for your changes?

Did you document any new/modified feature?

Notes

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!