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

docs: (IAC-1202) PostgreSQL Transfer Tooling Supplemental Doc #498

Merged
merged 6 commits into from
Oct 19, 2023

Conversation

dhoucgitter
Copy link
Member

@dhoucgitter dhoucgitter commented Oct 17, 2023

Changes

  • Move supplemental doc for users who followed the PostgreSQL Data Transfer Guide manual steps to migrate to an external Postgres Cluster and want to their deployment managed by viya4-deployment again to a separate .md file in the docs/user folder.
  • Add links to all three cloud provider PostgreSQL database server configuration sections.
  • Update steps to recommend modifying the V4_CFG_POSTGRES_SERVERS map default: entry to reference an external database server by changing it to internal: false instead of completely removing the server map entry.

@dhoucgitter dhoucgitter added the documentation Improvements or additions to documentation label Oct 17, 2023
@dhoucgitter dhoucgitter self-assigned this Oct 17, 2023
@sayeun
Copy link

sayeun commented Oct 17, 2023

May also be helpful to add a link to the DAC Postgres section. 

@dhoucgitter
Copy link
Member Author

May also be helpful to add a link to the DAC Postgres section.

@sayeun, there is a link to the DAC PostgreSQL CONFIG-VARS.md section here in the context of provisioning an external PostgreSQL cluster without using Viya4 IAC projects. Would you suggest adding a DAC PostgreSQL link along with the IAC PostgreSQL links, or elsewhere?

@dhoucgitter
Copy link
Member Author

@sayeun, added "Post" prefix to document .md file name that was missed before.

@dhoucgitter
Copy link
Member Author

@jkmin96, could you review and add comments for concerns or approve this PR if the updated doc content includes the requested changes that we discussed yesterday?

@jkmin96
Copy link
Collaborator

jkmin96 commented Oct 18, 2023

About title "## PostgreSQL Data Transfer Tool for the SAS Viya Platform - viya4-deployment Post-Transfer Steps (Experimental)"
I'm still not sure it would be o.k. to use "Post-transfer" term for this doc.

About "### Using IAC to create an external PostgreSQL database server"
Those PG instructions are based on the OOTB.
Can user just run IAC to add the external PG w/o doing any extra work for Viya? As I mentioned yesterday, I thought that stopping Viya is a requirement before updating the existing cluster. Please make sure if stopping Viya is not necessary.

@dhoucgitter
Copy link
Member Author

About title "## PostgreSQL Data Transfer Tool for the SAS Viya Platform - viya4-deployment Post-Transfer Steps (Experimental)" I'm still not sure it would be o.k. to use "Post-transfer" term for this doc.

About "### Using IAC to create an external PostgreSQL database server" Those PG instructions are based on the OOTB. Can user just run IAC to add the external PG w/o doing any extra work for Viya? As I mentioned yesterday, I thought that stopping Viya is a requirement before updating the existing cluster. Please make sure if stopping Viya is not necessary.

If the expected terraform plan/apply changes that are listed after only adding the PostgreSQL server map to their terraform-input.tfvars include destroying or re-creating a part of the cluster that Viya is currently using, for example substantive changes to existing resources other than the new PostgreSQL database server and recreating the jump server, then stopping Viya first makes sense. If the expected changes are just creating the PostgreSQL database server and jump server, I would not expect stopping Viya to be necessary. Since that advice can be left to some interpretation, perhaps we should always recommend stopping Viya, creating the new PostgreSQL server, then restarting Viya as the way to proceed. Thoughts?

Copy link
Collaborator

@jkmin96 jkmin96 left a comment

Choose a reason for hiding this comment

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

Please check if title is o.k. to include "post" since this doc includes about adding external PG.

Please check if stopping Viya is required when user adds external PGs to an existing cluster using IAC. If not, current doc is o.k.

Copy link

@sayeun sayeun left a comment

Choose a reason for hiding this comment

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

LGTM

@dhoucgitter dhoucgitter changed the base branch from staging to main October 18, 2023 20:40
@dhoucgitter dhoucgitter changed the base branch from main to staging October 18, 2023 20:43
@dhoucgitter dhoucgitter merged commit cb4812b into staging Oct 19, 2023
3 checks passed
@dhoucgitter dhoucgitter deleted the docs/iac-1202 branch October 19, 2023 13:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants