Skip to content

Commit

Permalink
Merge branch 'develop' into docs/edits_to_pgd_pr4766
Browse files Browse the repository at this point in the history
  • Loading branch information
djw-m authored Oct 12, 2023
2 parents d10d956 + 835f3c4 commit c562e85
Show file tree
Hide file tree
Showing 1,715 changed files with 8,635 additions and 7,552 deletions.
11 changes: 8 additions & 3 deletions .husky/_/husky.sh
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
#!/bin/sh
#!/usr/bin/env sh
if [ -z "$husky_skip_init" ]; then
debug () {
if [ "$HUSKY_DEBUG" = "1" ]; then
echo "husky (debug) - $1"
fi
}

readonly hook_name="$(basename "$0")"
readonly hook_name="$(basename -- "$0")"
debug "starting $hook_name..."

if [ "$HUSKY" = "0" ]; then
Expand All @@ -19,13 +19,18 @@ if [ -z "$husky_skip_init" ]; then
. ~/.huskyrc
fi

export readonly husky_skip_init=1
readonly husky_skip_init=1
export husky_skip_init
sh -e "$0" "$@"
exitCode="$?"

if [ $exitCode != 0 ]; then
echo "husky - $hook_name hook exited with code $exitCode (error)"
fi

if [ $exitCode = 127 ]; then
echo "husky - command not found in PATH=$PATH"
fi

exit $exitCode
fi
2 changes: 1 addition & 1 deletion .husky/pre-commit
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#!/bin/sh
. "$(dirname "$0")/_/husky.sh"

npx pretty-quick --staged --pattern 'src/**/*.js' --pattern 'gatsby-*.js'
npx lint-staged
4 changes: 4 additions & 0 deletions CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# First pass basic codeowners file

product_docs/docs/pgd/ @djw-m
product_docs/docs/epas/ @nidhibhammar
108 changes: 87 additions & 21 deletions advocacy_docs/community/contributing/styleguide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -346,9 +346,9 @@ If you need to enter a `value in a field`, type the `ls` or `dd` command, add a

See [Code](#code) for more information.

### Italics (*_text_*)
### Italics (`_text_`)

Use for book titles and first instance of terms. Do not use Italics for keywords.
Use for book titles and first instance of terms. Do not use _Italics_ for keywords.

### Underline

Expand Down Expand Up @@ -377,13 +377,8 @@ Link capitalization can be either title- or sentence-case:

Addresses are relative. In these examples of links to topics, “folder” means the folder in the repo such as the product folder or the guide folder. For the destination topic, use the name of the file without the .mdx extension. If the destination includes a topic\_identifier (sub-section of a file), include the topic\_identifier prefixed with a # sign, such as in “/09\_controlling\_logging/#enabling_syslog.”

| | | | | |
| --- | --- | --- | --- | --- |
| **Link type** | **Syntax** | **Example** | **Source path** | **Destination path** |

| | | | | |
| --- | --- | --- | --- | --- |
| **Link type** | **Syntax** | **Example** | **Source path** | **Destination path** |
| Another topic in the same folder | `[here](file_name)` | `[Using the EFM Utility](07_using_efm_utility/#using_efm_utility)` | /efm/4.2/efm\_user/07\_using_efm.mdx | /efm/4.2/efm\_user/07\_using\_efm\_utility.mdx |
| Another topic in a different folder at the same level | `[here](../dest_folder_name/file_name)` | \[The ERD Tool\](../pem\_ent\_feat/04\_pem\_erd_tool/) | /pem/8/pem\_rel\_notes/08\_810\_rel_notes.mdx | /pem/8/pem\_ent\_feat04\_pem\_erd_tool/ |
| Another topic in a different folder at a different level | `[here](../../folder_name/file_name`) | \[Enabling syslog Log File Entries\](../../09\_controlling\_logging/#enabling_syslog) | /efm/4.2/efm\_user/04\_configuring\_efm/01\_cluster_properties/index.mdx | /efm/4.2/efm\_user/09\_controlling\_logging.mdx/enabling\_syslog |
Expand All @@ -400,7 +395,11 @@ Addresses are relative. In these examples of links to topics, “folder” means

**Example:**

``# Anchor: <a id="flags-max-offset"></a>`--max-offset` # Link: [--max-offset](#flags-max-offset)``
```markdown
Anchor: <a id="flags-max-offset"></a> `--max-offset`

Link: [--max-offset](#flags-max-offset)
```


## Admonitions: notes, tips, and warnings
Expand Down Expand Up @@ -433,15 +432,41 @@ Code can be shown inline or as a code block.

### Inline code

Inline `code` has `back-ticks (``) around` it and is used when referring to code, commands, or other technical syntax within a sentence.
Inline `code` has back-ticks around it (`` `code` ``) and is used when referring to code, commands, or other technical syntax within a sentence.

Example: The `CREATE TABLE` statement creates a new table in a database.

### Nesting inline code

To format code that includes back-ticks, add additional back-ticks to demarcate: ``` `` \echo `date` `` ``` - note we need spaces to separate the demarcation from the code in this example.

### Code blocks

Code blocks provide executable code samples, marked with an opening and closing set of three backticks (` ``` `). Code blocks can support syntax highlighting if you add the language name immediately after the first line of backticks. Use one returned line before and after a code block for better Markdown readability. For example:

`This is a sample line of text. ``` {% include copy-clipboard.html %} ~~~shell $ go get -u github.com/lib/pq ~~~ ``` This is more sample text.`
````
This is a sample line of text.
```
{% include copy-clipboard.html %}
~~~shell
$ go get -u github.com/lib/pq
~~~
```
````
Which results in:

> This is a sample line of text.
>
> ```
> {% include copy-clipboard.html %}
> ~~~shell
> $ go get -u github.com/lib/pq
> ~~~
> ```
>
> This is more sample text.
Use syntax highlighting for configuration file , shell, and SQL commands, where appropriate, as follows.
Expand All @@ -455,21 +480,52 @@ SQL code samples are broken into two sections: commands and responses.
* **Commands** (e.g., `SELECT`, `CREATE TABLE`) begin with ` ```sql` followed by a line break. The first character of the next line should be the terminal marker `>`. Capitalize commands properly. Use only one command per code sample.
* **Responses** (e.g., retrieved tables) add (_ _ 0UTPUT _ _) on a line between the command and the output, you'll get highlights for the code but not the output. For example,

`
```sql SELECT slot_name, slot_type, database, active FROM pg_replication_slots ORDER BY 1; __OUTPUT__ slot_name | slot_type | database | active -------------+-----------+-----------+-------- xdb_47877_5 | logical | MMRnode_a | t xdb_47878_5 | logical | MMRnode_b | t xdb_47879_5 | logical | MMRnode_c | t (3 rows) ``` `

```
sql SELECT slot_name, slot_type, database, active FROM pg_replication_slots ORDER BY 1; __OUTPUT__ slot_name | slot_type | database | active -------------+-----------+-----------+-------- xdb_47877_5 | logical | MMRnode_a | t xdb_47878_5 | logical | MMRnode_b | t xdb_47879_5 | logical | MMRnode_c | t (3 rows)
```

* **Responses** (e.g., retrieved tables) add (`__OUTPUT__`) on a line between the command and the output, you'll get highlights for the code but not the output. For example,
````
```sql
SELECT slot_name, slot_type, database, active FROM pg_replication_slots ORDER BY 1;
__OUTPUT_
slot_name | slot_type | database | active
------------+-----------+-----------+--------
xdb_47877_5 | logical | MMRnode_a | t
xdb_47878_5 | logical | MMRnode_b | t
xdb_47879_5 | logical | MMRnode_c | t
(3 rows)
```
````
Results in
> ```sql
> SELECT slot_name, slot_type, database, active FROM pg_replication_slots ORDER BY 1;
> __OUTPUT__
> slot_name | slot_type | database | active
> ------------+-----------+-----------+--------
> xdb_47877_5 | logical | MMRnode_a | t
> xdb_47878_5 | logical | MMRnode_b | t
> xdb_47879_5 | logical | MMRnode_c | t
> (3 rows)
> ```
**Configuration file samples**
For files that have key-value pairs use ` ```ini`. For example:
` ```ini promotable=false auto.reconfigure=false ``` `
````
```ini
promotable=false
auto.reconfigure=false
```
````
Which results in:
> ```ini
> promotable=false
> auto.reconfigure=false
> ```
Tables
------
Expand All @@ -487,9 +543,19 @@ We don’t use outer pipes.
Example:
```
Term | Description | Example ----------|-----------------------------|---------------- `term_1` | This is a description. | `3.14` `term_2` | This is also a description. | `"lola mcdog"`
Term | Description | Example
----------|-----------------------------|----------------
`term_1` | This is a description. | `3.14`
`term_2` | This is also a description. | `"lola mcdog"`
```
Resulting in
Term | Description | Example
----------|-----------------------------|----------------
`term_1` | This is a description. | `3.14`
`term_2` | This is also a description. | `"lola mcdog"`
## Lists
EDB docs uses two types of lists:
Expand Down
13 changes: 13 additions & 0 deletions advocacy_docs/migrating/oracle/factors_to_consider.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ You'll want to think about these factors when analyzing and planning for your mi
- Infrastructure
- Applications
- Operations
- Server sizing

## Schema migration considerations

Expand Down Expand Up @@ -68,6 +69,18 @@ Migrating a legacy database to new database technology results in the need to up

Also, when legacy databases are running on older specialized hardware and operating systems, a database migration might also require migrating the underlying host systems to modern platforms and operating systems. For on-premises migrations, this can result in the need to change your operations and maintenance procedures and tools to work with the new server platforms and operating systems. For migrations to the cloud, some of the operations and maintenance activities will be handled by the cloud service provider but others will still be your responsibility. Likely, those activities will require different tools and procedures from the ones you're currently using.

## Sizing and configuration considerations

"How big a server will I need?"

This question comes up often when considering Oracle-to-Postgres migrations. The shortest answer is, "It depends," which isn't a good answer. A better one is, "Start with a 1:1 correspondence (that is, same number of cores, RAM, and so on), and go from there."

Why is that?

Postgres and Oracle are very different under the hood, with different SQL planning and different storage and access patterns. Even the version control and transaction isolation are implemented in a different way. That makes it difficult to set up a simple formula that covers all possible permutations of Oracle configurations and architectures. All databases respond differently to the workload being run.

Customers of EDB who have migrated to EDB Postgres Advanced Server have found performance on par with Oracle when using similar hardware. In some instances, depending on their workload, they even outperform Oracle. All our customers who migrated aimed to at least match Oracle's performance and, if feasible, to exceed it either on comparable hardware or by adding resources as needed. We also suggest conducting a benchmark using your specific workload to ensure the system meets performance expectations and to plan production accordingly.

## Some best practice considerations

The following are some best practices to consider when planning for your Oracle-to-Postgres database application migration:
Expand Down
12 changes: 12 additions & 0 deletions advocacy_docs/partner_docs/KastenbyVeeam/02-PartnerInformation.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: 'Partner information'
description: 'Details of the partner'

---
| &nbsp; | &nbsp; |
| ----------- | ----------- |
| **Partner name** | Kasten by Veeam |
| **Website** | https://www.kasten.io/ |
| **Partner product** | Kasten K10 |
| **Version** | Kasten 6.0 |
| **Product description** | Kasten K10 is a cloud-native data management platform for Day 2 operations. Built for Kubernetes, Kasten backs up and restores your applications, handles disaster recovery, and manages application migration. Kasten can be implemented with EDB Postgres for Kubernetes to create fast backups and restores. |
10 changes: 10 additions & 0 deletions advocacy_docs/partner_docs/KastenbyVeeam/03-SolutionSummary.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: 'Solution summary'
description: 'Explanation of the solution and its purpose'
---

Kasten by Veeam is a data management platform built for Kubernetes that can provide enterprise operations teams with an easy-to-use and secure system for backup and restore of Kubernetes applications. Kasten can be used with EDB Postgres for Kubernetes and the EDB external backup adapter to successfully back up and restore data.

The EDB Postgres for Kubernetes [external backup adapter](https://www.enterprisedb.com/docs/postgres_for_kubernetes/latest/addons/#external-backup-adapter) allows for a third-party tool, such as Kasten by Veeam, to discover an API that's needed to create a successful backup.

![Kasten K10 Architecture](Images/KastenSolutionSummaryImagenew.png)
Loading

1 comment on commit c562e85

@github-actions
Copy link
Contributor

Choose a reason for hiding this comment

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

Please sign in to comment.