You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by GitBox <gi...@apache.org> on 2021/06/18 20:58:52 UTC
[GitHub] [apisix-dashboard] nic-chen opened a new issue #1944: When Dashboard and APISIX version do not match, make the prompt information clearer
nic-chen opened a new issue #1944:
URL: https://github.com/apache/apisix-dashboard/issues/1944
# Feature request
## Please describe your feature
When the APISIX version does not match the Dashboard version, the prompt information is not clear enough to allow users to directly know why the prompt is prompted. The matching version should be given directly
## Describe the solution you'd like
Add the current version number and the required version in the prompt message
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-dashboard] juzhiyuan commented on issue #1944: When Dashboard and APISIX version do not match, make the prompt information clearer
Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on issue #1944:
URL: https://github.com/apache/apisix-dashboard/issues/1944#issuecomment-879611188
also cc @liuxiran @nic-chen @RedemptionC @Applenice @iamayushdas @sshniro to have a look, thanks!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-dashboard] RedemptionC commented on issue #1944: When Dashboard and APISIX version do not match, make the prompt information clearer
Posted by GitBox <gi...@apache.org>.
RedemptionC commented on issue #1944:
URL: https://github.com/apache/apisix-dashboard/issues/1944#issuecomment-872789743
> Hi, I would suggest using the latter one, and show a modal to tell users which node is mismatch with Dashboard :)
Hi,what does "show a modal" mean?That's not very intuitive to me,could you give me a example or point me to some useful resource?Thank you
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-dashboard] RedemptionC edited a comment on issue #1944: When Dashboard and APISIX version do not match, make the prompt information clearer
Posted by GitBox <gi...@apache.org>.
RedemptionC edited a comment on issue #1944:
URL: https://github.com/apache/apisix-dashboard/issues/1944#issuecomment-872181531
Hi all,maybe I can try to imporve this if no one else is currently working on it
As I don't know much about the front end skills yet,I will only work on the back end part
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-dashboard] RedemptionC edited a comment on issue #1944: When Dashboard and APISIX version do not match, make the prompt information clearer
Posted by GitBox <gi...@apache.org>.
RedemptionC edited a comment on issue #1944:
URL: https://github.com/apache/apisix-dashboard/issues/1944#issuecomment-881903323
> > And there is a situation that needs to be explained:
> > If a newer version of APISIX is used with an older version of Dashboard, there is no way for Dashboard to know what version of Dashboard should be used for the newer version of APISIX.
>
> Regarding this point, I don't think I have made it clear.
>
> Here is an example:
>
> A user installs APISIX 2.7 and Dashboard 2.7, they will not match.
>
> But at this time Dashboard cannot find out APISIX 2.7 should match which version of Dashboard.
>
> Because there is no corresponding data in the version matched map (the largest version are APISIX 2.6 and Dashboard 2.7).
>
> @juzhiyuan @starsz @liuxiran
I think the version map only tell us:what version of APISIX should be used with this version of dashboard,not vice versa,do I misunderstand it?
@nic-chen @juzhiyuan
Or should we just search the entries in versionMap,and find the corresponding dashboard version of the APISIX?
Another question,when mismatch happened,if neither of them are the latest,which one should we change?Or should we upgrade both of them to the latest?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-dashboard] RedemptionC commented on issue #1944: When Dashboard and APISIX version do not match, make the prompt information clearer
Posted by GitBox <gi...@apache.org>.
RedemptionC commented on issue #1944:
URL: https://github.com/apache/apisix-dashboard/issues/1944#issuecomment-873429973
> see https://ant.design/components/modal-cn/
I see,but as I said:
>Hi all,maybe I can try to imporve this if no one else is currently working on it
>As I don't know much about the front end skills yet,I will only work on the back end part
maybe I can't do the front-end part now..What do you think,any advice will be appreciated
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-dashboard] nic-chen commented on issue #1944: When Dashboard and APISIX version do not match, make the prompt information clearer
Posted by GitBox <gi...@apache.org>.
nic-chen commented on issue #1944:
URL: https://github.com/apache/apisix-dashboard/issues/1944#issuecomment-883225012
@RedemptionC
1. we could search the entries in version Map, and find the corresponding dashboard version of the APISIX
2. There is no way for Manager API to know whether itself is the latest version. So we can only let users decide for themselves.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-dashboard] nic-chen commented on issue #1944: When Dashboard and APISIX version do not match, make the prompt information clearer
Posted by GitBox <gi...@apache.org>.
nic-chen commented on issue #1944:
URL: https://github.com/apache/apisix-dashboard/issues/1944#issuecomment-872252385
> Hi all,maybe I can try to imporve this if no one else is currently working on it
> As I don't know much about the front end skills yet,I will only work on the back end part
OK, thanks
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-dashboard] starsz commented on issue #1944: When Dashboard and APISIX version do not match, make the prompt information clearer
Posted by GitBox <gi...@apache.org>.
starsz commented on issue #1944:
URL: https://github.com/apache/apisix-dashboard/issues/1944#issuecomment-879951848
> But the valid_dashboard_version does not look conspicuous enough for users to see
+1 , Where is the `valid_dashboard_version`.
> And there is a situation that needs to be explained:
It will. default ttl is 7200 seconds.
https://github.com/apache/apisix/blob/bfa70e4f86ca13aca588ba9f59cf24f334200b31/apisix/plugins/server-info.lua#L30
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-dashboard] iamayushdas commented on issue #1944: When Dashboard and APISIX version do not match, make the prompt information clearer
Posted by GitBox <gi...@apache.org>.
iamayushdas commented on issue #1944:
URL: https://github.com/apache/apisix-dashboard/issues/1944#issuecomment-868984577
seems like @bzp2010 working on this
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-dashboard] Applenice commented on issue #1944: When Dashboard and APISIX version do not match, make the prompt information clearer
Posted by GitBox <gi...@apache.org>.
Applenice commented on issue #1944:
URL: https://github.com/apache/apisix-dashboard/issues/1944#issuecomment-868556014
I have also encountered this error, here if the display version information will be more friendly and clear.In the console Network can see the response of `/apisix/admin/tool/version_match`:
```
{
"code": 2000001,
"message": "The manager-api and apache apisix are mismatched.",
"data": {
"matched": false,
"dashboard_version": "2.7",
"mismatched_nodes": [
{
"hostname": "XXX",
"version": "2.5"
}
]
},
"request_id": "d5102895-a0c7-4913-a2db-ce4baaebc17b"
}
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-dashboard] juzhiyuan commented on issue #1944: When Dashboard and APISIX version do not match, make the prompt information clearer
Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on issue #1944:
URL: https://github.com/apache/apisix-dashboard/issues/1944#issuecomment-863818911
API should return the matched version list and web should show Translation :)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-dashboard] juzhiyuan commented on issue #1944: When Dashboard and APISIX version do not match, make the prompt information clearer
Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on issue #1944:
URL: https://github.com/apache/apisix-dashboard/issues/1944#issuecomment-881148413
1. maintain a version mapper;
2. if we cannot find which dashboard is compatible with APISIX, just shows: `No available version, please contact the community`, and lead users to GitHub.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-dashboard] nic-chen edited a comment on issue #1944: When Dashboard and APISIX version do not match, make the prompt information clearer
Posted by GitBox <gi...@apache.org>.
nic-chen edited a comment on issue #1944:
URL: https://github.com/apache/apisix-dashboard/issues/1944#issuecomment-868848041
@iamayushdas @bzp2010
Would you like to optimize it? A lot of people have raised this issue recently.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-dashboard] RedemptionC commented on issue #1944: When Dashboard and APISIX version do not match, make the prompt information clearer
Posted by GitBox <gi...@apache.org>.
RedemptionC commented on issue #1944:
URL: https://github.com/apache/apisix-dashboard/issues/1944#issuecomment-881903323
> > And there is a situation that needs to be explained:
> > If a newer version of APISIX is used with an older version of Dashboard, there is no way for Dashboard to know what version of Dashboard should be used for the newer version of APISIX.
>
> Regarding this point, I don't think I have made it clear.
>
> Here is an example:
>
> A user installs APISIX 2.7 and Dashboard 2.7, they will not match.
>
> But at this time Dashboard cannot find out APISIX 2.7 should match which version of Dashboard.
>
> Because there is no corresponding data in the version matched map (the largest version are APISIX 2.6 and Dashboard 2.7).
>
> @juzhiyuan @starsz @liuxiran
I think the version map only tell us:what version of APISIX should be used with this version of dashboard,not vice versa,do I misunderstand it?
@nic-chen
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-dashboard] RedemptionC commented on issue #1944: When Dashboard and APISIX version do not match, make the prompt information clearer
Posted by GitBox <gi...@apache.org>.
RedemptionC commented on issue #1944:
URL: https://github.com/apache/apisix-dashboard/issues/1944#issuecomment-872181531
Hi all,maybe I can try to imporve this if no one else is currently working on it
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-dashboard] juzhiyuan commented on issue #1944: When Dashboard and APISIX version do not match, make the prompt information clearer
Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on issue #1944:
URL: https://github.com/apache/apisix-dashboard/issues/1944#issuecomment-881149270
@liuxiran When users use the Dashboard, which part they will pay more attention to the versions? They will be careful with "Which dashboard should I use to configure the APISIX"?
According to the prototype, it just added some fields:
- What's the current Dashboard's version?
- Which versions of the dashboard are compatible with APISIX nodes?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-dashboard] RedemptionC commented on issue #1944: When Dashboard and APISIX version do not match, make the prompt information clearer
Posted by GitBox <gi...@apache.org>.
RedemptionC commented on issue #1944:
URL: https://github.com/apache/apisix-dashboard/issues/1944#issuecomment-872339707
Hi,I am not sure what's the proper way to improve:
1. should we just change the prompt message? As it's indicated in the issue description
2. or should we make some further improvements? like @juzhiyuan and @nic-chen mentioned in the comments:
>API should return the matched version list and web should show Translation :)
If it's the former one,we just need to change change the code snippet from
```go
Message: "The manager-api and apache apisix are mismatched.",
```
to something like
```go
Message: fmt.Sprintf("The Dashboard and Apache APISIX are mismatched. \nThe version of Dashboard is %s and should be used with APISIX %s", "version", "matchedVersion"),
```
If it's the latter one,what's the matched version list?As the versionMap.go shows,there is a one to one mapping,so I don't quite get it
And,should we put the mismatched nodes' info into the prompt message? As the picture showed
Please give me some advice,thank you
@juzhiyuan @nic-chen
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-dashboard] tokers closed issue #1944: When Dashboard and APISIX version do not match, make the prompt information clearer
Posted by GitBox <gi...@apache.org>.
tokers closed issue #1944:
URL: https://github.com/apache/apisix-dashboard/issues/1944
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-dashboard] iamayushdas commented on issue #1944: When Dashboard and APISIX version do not match, make the prompt information clearer
Posted by GitBox <gi...@apache.org>.
iamayushdas commented on issue #1944:
URL: https://github.com/apache/apisix-dashboard/issues/1944#issuecomment-873725541
#1965 issue raised regarding status code
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-dashboard] Applenice commented on issue #1944: When Dashboard and APISIX version do not match, make the prompt information clearer
Posted by GitBox <gi...@apache.org>.
Applenice commented on issue #1944:
URL: https://github.com/apache/apisix-dashboard/issues/1944#issuecomment-880001091
> In fact, we could also support telling users where to download the compatible software, and how to upgrade it.
>
> Also, if the Dashboard has the ability to handle field change, that would reduce field-change-publishment.
I also think it might be better to give a link to the version that matches when the error message pops up.😋Provide an entry point in README?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-dashboard] juzhiyuan commented on issue #1944: When Dashboard and APISIX version do not match, make the prompt information clearer
Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on issue #1944:
URL: https://github.com/apache/apisix-dashboard/issues/1944#issuecomment-885051655
In the current architecture where DP and CP are separated, each party needs to maintain JSONSchema data. Moreover, when APISIX is upgraded (API field additions and deletions, plugins and their field additions and deletions), Dashboard also needs to finish adapting and releasing new versions as soon as possible, otherwise using a mismatched Dashboard will write data in ETCD that APISIX may not support and create new problems. Therefore, global hinting in Dashboard is not desirable and does not solve the fundamental problem.
To solve the problem of Dashboard and APISIX adaptation, the following plan is adopted, divided into 3 phases.
**Phase 1**
The first phase requires a quick solution to the problem in the following way.
1. Now, the latest version of Dashboard is 2.7, and the latest version of APISIX is 2.7.
2. Disregard the historical version matching problem and deprecate the version matching logic (manually maintaining a Mapper).
3. Compare Dashboard 2.7 with APISIX 2.7 and sort out where Dashboard's existing features are inconsistent with APISIX (API fields, plugin schema).
4. Update Dashboard to match the existing features with APISIX 2.7 and release version 2.7.1.
**Phase 2**
The second phase requires enriching Dashboard functionality to match APISIX functionality.
1. Sort out which APISIX 2.7 features are not implemented in Dashboard 2.7.1, such as Stream Proxy, Service Discovery, etc.
2. Update the Dashboard to include the existing features of APISIX 2.7 and release version 2.7.2.
**Phase 3**
Phase 3 requires the Dashboard to synchronize the APISIX release schedule and release APISIX with the same version number, e.g., 2.8, within a manageable time frame after the release of APISIX.
1. APISIX milestones are visible in GitHub.
2. After APISIX is released, sort out what is different between APISIX and the previous version, and then adapt it in Dashboard.
**Another Phase**
In addition, I have a long-term plan, the current architecture is to separate DP and CP, and the ManagerAPI in CP does a lot of functions that AdminAPI duplicates, so we might as well deprecate ManagerAPI and turn Dashboard into **a pure Web project**, directly accessing AdminAPI, so that when the data in the Request Body is illegal, AdminAPI will return an error directly. Of course, this requires a more detailed solution design and is a big change.
What do you think?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-dashboard] juzhiyuan commented on issue #1944: When Dashboard and APISIX version do not match, make the prompt information clearer
Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on issue #1944:
URL: https://github.com/apache/apisix-dashboard/issues/1944#issuecomment-873482412
got, wait for more contributors :)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-dashboard] juzhiyuan commented on issue #1944: When Dashboard and APISIX version do not match, make the prompt information clearer
Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on issue #1944:
URL: https://github.com/apache/apisix-dashboard/issues/1944#issuecomment-872986404
see https://ant.design/components/modal-cn/
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-dashboard] juzhiyuan commented on issue #1944: When Dashboard and APISIX version do not match, make the prompt information clearer
Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on issue #1944:
URL: https://github.com/apache/apisix-dashboard/issues/1944#issuecomment-881155507
@iamayushdas Hi, please see https://github.com/apache/apisix-dashboard/issues/1944#issuecomment-879607016
Do you have to take this issue?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-dashboard] nic-chen commented on issue #1944: When Dashboard and APISIX version do not match, make the prompt information clearer
Posted by GitBox <gi...@apache.org>.
nic-chen commented on issue #1944:
URL: https://github.com/apache/apisix-dashboard/issues/1944#issuecomment-868848041
@iamayushdas @bzp2010 would you like to optimize it?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-dashboard] nic-chen commented on issue #1944: When Dashboard and APISIX version do not match, make the prompt information clearer
Posted by GitBox <gi...@apache.org>.
nic-chen commented on issue #1944:
URL: https://github.com/apache/apisix-dashboard/issues/1944#issuecomment-883225012
@RedemptionC
1. we could search the entries in version Map, and find the corresponding dashboard version of the APISIX
2. There is no way for Manager API to know whether itself is the latest version. So we can only let users decide for themselves.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-dashboard] nic-chen commented on issue #1944: When Dashboard and APISIX version do not match, make the prompt information clearer
Posted by GitBox <gi...@apache.org>.
nic-chen commented on issue #1944:
URL: https://github.com/apache/apisix-dashboard/issues/1944#issuecomment-872030798
Could we change the prompt pop-up to something like this?
Let users know what version of Dashboard and APISIX should be used.
@juzhiyuan @liuxiran @LiteSun
what do you think?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-dashboard] juzhiyuan commented on issue #1944: When Dashboard and APISIX version do not match, make the prompt information clearer
Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on issue #1944:
URL: https://github.com/apache/apisix-dashboard/issues/1944#issuecomment-879607016
## Background
Currently, Apache APISIX Dashboard and Apache APISIX are two separate projects (hereinafter referred to as Dashboard and APISIX). Whenever APISIX changes (Create/Update/Delete) content (e.g., APIs, API fields, Entity definitions, etc.), Dashboard needs to match the changes and publish a new version, otherwise, an exception will occur when using it. There are 2 cases.
**Case 1: When APISIX extends the Upstream object with new fields**
1. User creates an Upstream object using the Admin API;
2. User edits the object using Dashboard and finds that:
1. The interface fails to display all fields.
2. When the data is submitted, the new field is missing from the submitted data because the API does not support it, producing the wrong expected result.
**Case 2: Deleting a field**
1. If the Dashboard only updates schema.json but not the Web, the schema checksum will fail when the data is submitted.
2. If the Dashboard is not updated, then the submission data will be written to redundant fields.
In addition, it is possible for JS to generate `null.xxx` because a field is missing, which in turn causes JS to throw an error.
Therefore, it is not recommended to use a mismatched Dashboard to operate APISIX.
## Solution Target
To globally alert the user when a Dashboard does not match APISIX and allow the user to see more information about it:
1. What is the current Dashboard version? What APISIX versions are supported?
2. What APISIX nodes are currently available? What are the versions? Which ones don't match (need to highlight)
## Solution
1. When APISIX nodes are all compatible with the Dashboard, no alert occurred.
2. When any APISIX node does not match the Dashboard version, a version mismatch will be displayed at the top of the screen.
3. Clicking View Details will bring you to the System Info page, and the mismatched node will be bound with a `Red Tag`, also, there will add a `valid_dashboard_version` field for every node.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-dashboard] juzhiyuan commented on issue #1944: When Dashboard and APISIX version do not match, make the prompt information clearer
Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on issue #1944:
URL: https://github.com/apache/apisix-dashboard/issues/1944#issuecomment-879610792
In fact, we could also support telling users where to download the compatible software, and how to upgrade it.
Also, if the Dashboard has the ability to handle field change, that would reduce field-change-publishment.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-dashboard] nic-chen commented on issue #1944: When Dashboard and APISIX version do not match, make the prompt information clearer
Posted by GitBox <gi...@apache.org>.
nic-chen commented on issue #1944:
URL: https://github.com/apache/apisix-dashboard/issues/1944#issuecomment-879708723
LGTM.
But the `valid_dashboard_version` does not look conspicuous enough for users to see.
And there is a situation that needs to be explained:
If a newer version of APISIX is used with an older version of Dashboard, there is no way for Dashboard to know what version of Dashboard should be used for the newer version of APISIX.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-dashboard] nic-chen commented on issue #1944: When Dashboard and APISIX version do not match, make the prompt information clearer
Posted by GitBox <gi...@apache.org>.
nic-chen commented on issue #1944:
URL: https://github.com/apache/apisix-dashboard/issues/1944#issuecomment-880557115
> And there is a situation that needs to be explained:
If a newer version of APISIX is used with an older version of Dashboard, there is no way for Dashboard to know what version of Dashboard should be used for the newer version of APISIX.
Regarding this point, I don't think I have made it clear.
Here is an example:
A user installs APISIX 2.7 and Dashboard 2.7, they will not match.
But at this time Dashboard cannot find out APISIX 2.7 should match which version of Dashboard.
Because there is no corresponding data in the version matched map (the largest version are APISIX 2.6 and Dashboard 2.7).
@juzhiyuan @starsz @liuxiran
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-dashboard] LiteSun commented on issue #1944: When Dashboard and APISIX version do not match, make the prompt information clearer
Posted by GitBox <gi...@apache.org>.
LiteSun commented on issue #1944:
URL: https://github.com/apache/apisix-dashboard/issues/1944#issuecomment-872653576
I would suggest using the latter one too, how about put mismatched node info on the system info page?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-dashboard] juzhiyuan commented on issue #1944: When Dashboard and APISIX version do not match, make the prompt information clearer
Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on issue #1944:
URL: https://github.com/apache/apisix-dashboard/issues/1944#issuecomment-872646810
Hi, I would suggest using the latter one, and show a modal to tell users which node is mismatch with Dashboard :)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-dashboard] starsz edited a comment on issue #1944: When Dashboard and APISIX version do not match, make the prompt information clearer
Posted by GitBox <gi...@apache.org>.
starsz edited a comment on issue #1944:
URL: https://github.com/apache/apisix-dashboard/issues/1944#issuecomment-879951848
> But the valid_dashboard_version does not look conspicuous enough for users to see
+1 , Where is the `valid_dashboard_version`.
> And there is a situation that needs to be explained:
It will. default ttl is 7200 seconds.
https://github.com/apache/apisix/blob/bfa70e4f86ca13aca588ba9f59cf24f334200b31/apisix/plugins/server-info.lua#L30
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-dashboard] juzhiyuan edited a comment on issue #1944: When Dashboard and APISIX version do not match, make the prompt information clearer
Posted by GitBox <gi...@apache.org>.
juzhiyuan edited a comment on issue #1944:
URL: https://github.com/apache/apisix-dashboard/issues/1944#issuecomment-879611188
also cc @liuxiran @nic-chen @RedemptionC @Applenice @iamayushdas @sshniro @guoqqqi to have a look, thanks!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-dashboard] liuxiran commented on issue #1944: When Dashboard and APISIX version do not match, make the prompt information clearer
Posted by GitBox <gi...@apache.org>.
liuxiran commented on issue #1944:
URL: https://github.com/apache/apisix-dashboard/issues/1944#issuecomment-880425729
I agree to use fixed warning tip when the version of dashboard and APISIX are not matched.
> I also think it might be better to give a link to the version that matches when the error message pops up.😋Provide an entry point in README?
and inspired by @Applenice there are some enhancements in order that user could quickly get the target version of components
Additionally, we can also add an FAQ to help your how to let dashboard work smoothly with APISIX.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-dashboard] juzhiyuan edited a comment on issue #1944: When Dashboard and APISIX version do not match, make the prompt information clearer
Posted by GitBox <gi...@apache.org>.
juzhiyuan edited a comment on issue #1944:
URL: https://github.com/apache/apisix-dashboard/issues/1944#issuecomment-881149270
@liuxiran When users use the Dashboard, which part they will pay more attention to the versions? They will be careful with "Which dashboard should I use to configure the APISIX"?
According to the prototype, it just added some fields:
- dashboard - version: What's the current Dashboard's version?
- valid_dashboard_versions: Which versions of the dashboard are compatible with APISIX nodes?
Yes, it would be better to have a download link with every version.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-dashboard] nic-chen commented on issue #1944: When Dashboard and APISIX version do not match, make the prompt information clearer
Posted by GitBox <gi...@apache.org>.
nic-chen commented on issue #1944:
URL: https://github.com/apache/apisix-dashboard/issues/1944#issuecomment-883225012
@RedemptionC
1. we could search the entries in version Map, and find the corresponding dashboard version of the APISIX
2. There is no way for Manager API to know whether itself is the latest version. So we can only let users decide for themselves.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org