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

BP - Deployment #663

Merged
merged 39 commits into from
May 15, 2024
Merged

BP - Deployment #663

merged 39 commits into from
May 15, 2024

Conversation

antejavor
Copy link
Contributor

@antejavor antejavor commented Apr 8, 2024

Best practices deployment PR:

TODO (Ante) :

TODO (Matea):

TODO (Katarina)

  • Check the docker config changes #696 @katarinasupe -> Stage 1
  • Create Docker page under Database management -> Stage 1
  • Create Docker Compose page under Database management -> Stage 2 (?) TBD
  • Create Cloud deployment page under Database management -> Stage 2
  • Add structural changes to the docs -> Stage 1
  • HA cluster setup - Docker page -> Stage 2
  • Monitoring - Docker page -> Stage 2

Review all changed/transferred pages -> Stage 1

  • Review Data durability under Fundamentals
  • Review Audit log under Logs
  • Review Authorization and Authentication
  • Review Database management
  • Review Backup and restore
  • Review Clustering
  • Review Query metadata
  • Review Monitoring
  • Review Text search under Querying

To be discussed on a daily:

Plan:

Wrap up Stage 1 by May 10, open new PR after that for Stage 2.

Changes to structure

New sections:
Deployment (Docker, Docker Compose and Kubernetes)
Clustering

Configuration restructure:

  • Configuration renamed to Database management
  • Audit log has been deleted and transferred under Logs
  • Auth module has been deleted and placed under new Auth system integrations under Authentication and authorization
  • Configuration settings renamed to Configuration
  • Data durability and backup renamed to Backup and restore and Data durability knowledge transferred under Fundamentals
  • High availability is transferred to Clustering
  • Metadata renamed to Query metadata
  • Monitoring server renamed to Monitoring
  • Replication is placed under Clustering
  • Security page is deleted and replaced by Authentication and authorization
  • New page -> Authentication and authorization -> Users (old create user from Security), Role-based access control (old Role-based and Label-based from Security) and Auth system integrations (LDAP, OAuth, Auth module) under it
  • Text search has been transferred to Querying

Based on the structural changes above, redirects have to be added in, pages and links have to be reviewed.

UPDATE: Pages are reviews, links on those pages updated. Links leading to old pages can be updated (are not yet) and redirects have to be added.

NOTE: I still vote for Clustering under Database management (Kate)
NOTE: Whenever the format of /var/lib/memgraph changes, this is a breaking change if it's not made backwards compatible

Update the OS install commands and OS information.
Copy link

vercel bot commented Apr 8, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
documentation ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 15, 2024 6:19am

Refactoring of the configuration page.
Add Linux installation pages. 
---------

Co-authored-by: Katarina Supe <61758502+katarinasupe@users.noreply.github.com>
Co-authored-by: Kruno Golubic <46486712+kgolubic@users.noreply.github.com>
@katarinasupe
Copy link
Contributor

@antejavor should MEMGRAPH_CONFIG be listed in the Env vars table as well?

@antejavor antejavor mentioned this pull request Apr 19, 2024
10 tasks
Add context for configuration files. 

Co-authored-by: Katarina Supe <61758502+katarinasupe@users.noreply.github.com>

---------

Co-authored-by: Katarina Supe <61758502+katarinasupe@users.noreply.github.com>
* Update config settings for Docker Compose

* update content

* Update pages/getting-started/install-memgraph/docker-compose.mdx

Co-authored-by: Katarina Supe <61758502+katarinasupe@users.noreply.github.com>

---------

Co-authored-by: Katarina Supe <61758502+katarinasupe@users.noreply.github.com>
* docker management init

* update

* code fixes

* update

* Fix vercel build error

* Change naming

---------

Co-authored-by: kgolubic <kgolubic@gmail.com>
katarinasupe and others added 2 commits May 10, 2024 16:09
Add linux page. 

Co-authored-by: Katarina Supe <61758502+katarinasupe@users.noreply.github.com>

---------

Co-authored-by: Katarina Supe <61758502+katarinasupe@users.noreply.github.com>
@katarinasupe
Copy link
Contributor

@kgolubic This is basically done, but we need to resolve conflicts and see what the best time and way to merge, depending on the releases. Let's sync next week.

@katarinasupe katarinasupe self-requested a review May 14, 2024 07:18
@katarinasupe katarinasupe added status: ready PR is ready for review and removed status: draft PR is still a draft labels May 14, 2024
@katarinasupe katarinasupe marked this pull request as ready for review May 14, 2024 07:24
@katarinasupe
Copy link
Contributor

@kgolubic this is ready for review. Ante told me you can deal with conflicts. Let me know if something is unclear or needed from our side.

Copy link
Collaborator

@kgolubic kgolubic left a comment

Choose a reason for hiding this comment

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

Everything looks OK.

@kgolubic kgolubic merged commit d35a9a3 into main May 15, 2024
2 checks passed
@kgolubic kgolubic deleted the BP-deployment branch May 15, 2024 11:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: ready PR is ready for review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants