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.

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

Installdocs 1 #1820

Merged
merged 4 commits into from
Nov 7, 2023
Merged

Installdocs 1 #1820

merged 4 commits into from
Nov 7, 2023

Conversation

lynnbendixsen
Copy link
Contributor

Node installation documents to install the server.

@lynnbendixsen lynnbendixsen requested a review from a team as a code owner September 26, 2023 23:05
@@ -0,0 +1,66 @@
# Troubleshooting - Adding or Upgrading Indy Nodes
Many things can go wrong while adding or upgrading nodes on an existing Indy network and this guide will cover symptoms and issues encountered and some steps you might take to recover from those. The steps listed are likely just possible remedies to the listed issues. Feel free to add more remedies or issues if you don't see your's included here. As bugs are fixed, the issues noted below might not occur any more, or might have a different remedy.
Copy link
Member

Choose a reason for hiding this comment

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

Scary. Perhaps just “Things an go wrong…"

This section covers troubleshooting the addition of a node to a network. This can occur either as part of an upgrade (e.g. the 20.04 upgrade) or as part of a new node being added to an existing network.

### Symptom 1 - Node is unresponsive
- Cause #1 - Node is performing catchup. (Large Network)
Copy link
Member

Choose a reason for hiding this comment

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

Given the discussion on the Indy Contributor’s call this week (2023.09.26), should the instructions not always say to have a “recent” copy of the Indy Node data folder for the network, so the “long catchup” is not an issue?

When upgrading, the advice can be to use the node’s own data folder.

When adding a new node, include a step where the node operator’s technical team provides a data folder from another node.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Wade has not experienced the issue, it seems, so I wondered whether "every time" is appropriate for all networks. Until we figure out why this is only happening for me, maybe it's okay to leave this as is?
"Own" data folder is a great idea for the upgrade scenario.

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 any time I can reduce the “wait” for something that might turn out badly is a good thing.

Not required — I just thing it is a good “best practice” vs. having nodes start from scratch. It doesn’t have to be a “to the minute” — it can be a “recent” backup to get (what appears to me to be) a significant benefit.

6. On your 2FA phone app, add an account, and then scan the barcode or enter the 16 character secret key from step 4’s output.
7. Log out and then log back in to check and make sure it worked!
5. All of your secondary admin users should be setup now.
30. You can now begin the Indy Node installation using the Validator Preparation Guide.
Copy link
Member

Choose a reason for hiding this comment

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

Is there a link available to the guide?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

not yet, a future PR will have the guide in it

@swcurran
Copy link
Member

Awesome stuff. I added a couple of notes — one of which would seem to be important — the use of a data folder for the network when adding or upgrading a network.

swcurran
swcurran previously approved these changes Sep 29, 2023
@swcurran
Copy link
Member

To clairfy my approval. I didn’t go through the steps in detail — just assume that a “best effort” was done in creating the steps, and from this basis we can evolve the steps further.

@lynnbendixsen
Copy link
Contributor Author

Modified troubleshooting slightly based on Stephens comments above. I am not understanding why "statusCheck" is not passing, so some help here would be good. thx!

…they have trouble while adding a node to a network. Some workarounds for bugs I encountered are included as well.

Signed-off-by: Lynn Bendixsen <lynn@indicio.tech>
Signed-off-by: Lynn Bendixsen <lynn@indicio.tech>
…e in this commit. These install files are the ones that Indicio and Sovrin are using for the initial installation of servers in different scenarios.

Signed-off-by: Lynn Bendixsen <lynn@indicio.tech>
Signed-off-by: Lynn Bendixsen <lynn@indicio.tech>
@lynnbendixsen
Copy link
Contributor Author

Fixed a DCO issue (last set of commits)

@WadeBarnes WadeBarnes merged commit b9d916a into hyperledger:main Nov 7, 2023
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants