Skip to content

Commit

Permalink
Updated references to develop branches to refer to main instead
Browse files Browse the repository at this point in the history
  • Loading branch information
ac74475 committed Aug 4, 2021
1 parent bbbeaff commit 07f9ae3
Show file tree
Hide file tree
Showing 8 changed files with 14 additions and 14 deletions.
8 changes: 4 additions & 4 deletions QUICKSTART.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,14 +36,14 @@ Run the cross-platform [quickstart.cmd script](https://github.com/gchq/Palisade/
```

This will perform the following tasks necessary to set-up and start using Palisade:
* Download each of the Palisade repos required to run the example ([services](https://github.com/gchq/Palisade-services/tree/develop) and [examples](https://github.com/gchq/Palisade-examples/tree/develop))
* Download each of the Palisade repos required to run the example ([services](https://github.com/gchq/Palisade-services/tree/main) and [examples](https://github.com/gchq/Palisade-examples/tree/main))
- We will be pulling the 0.5.1 release which uses a Kafka-based streaming microservice architecture
* Run the Palisade local-k8s example (more details [can be found here](https://github.com/gchq/Palisade-examples/tree/develop/deployment-k8s/local-k8s)), which pulls down the images from [DockerHub](https://hub.docker.com/u/gchq).
* Run the Palisade local-k8s example (more details [can be found here](https://github.com/gchq/Palisade-examples/tree/main/deployment-k8s/local-k8s)), which pulls down the images from [DockerHub](https://hub.docker.com/u/gchq).

The script will have done an example run-through of Palisade, demonstrating a client with different users and purposes querying some Avro files for employee data, with some redaction and masking rules in place.
The output of this example run-through will be written to the terminal once it has completed, and if deployed successfully, you will see a success message returned.
To view the logs of the services, use Kubernetes and run `kubectl get logs <ServiceName>-Service`.
More details of these rules and data structures [can be found here](https://github.com/gchq/Palisade-examples/tree/develop/example-library).
More details of these rules and data structures [can be found here](https://github.com/gchq/Palisade-examples/tree/main/example-library).

This shutdown procedure can be automated using the [quickstop.cmd script](https://github.com/gchq/Palisade/blob/main/quickstop.cmd):
* On Linux/MacOS:
Expand All @@ -59,7 +59,7 @@ See the individual repositories and modules for their specific documentation fro
## Alternative Deployments

### Local JVM
Palisade is also set-up for a JVM deployment, which [is documented here](https://github.com/gchq/Palisade-examples/tree/develop/deployment-jvm/local-jvm/README.md).
Palisade is also set-up for a JVM deployment, which [is documented here](https://github.com/gchq/Palisade-examples/tree/main/deployment-jvm/local-jvm/README.md).
To run this example, you will need local installations of each service's jars, which involves cloning the remaining Palisade repositories, and using [maven](https://maven.apache.org/), installing them in the correct order, before following the local-jvm readme linked above.
The correct installation order for Palisade is:
1. [Palisade-common](https://github.com/gchq/Palisade-common)
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Palisade allows the policies for accessing datasets, redacting records and execu
This will enable the clients to perform queries across the datasets while still conforming to company and regulatory policies.

> :information_source:
See the [Motivating Scenario](src/motivating_scenario.md) for a detailed description of this example scenario, and the [Example Library](https://github.com/gchq/Palisade-examples/tree/develop/example-library) package for the concrete implementation of this example used for testing.
See the [Motivating Scenario](src/motivating_scenario.md) for a detailed description of this example scenario, and the [Example Library](https://github.com/gchq/Palisade-examples/tree/main/example-library) package for the concrete implementation of this example used for testing.

Policies are set per resource and are not changed by the user or context.
However, the policies can use the information about the user and context to decide how the data needs to be sanitised for any particular query.
Expand Down
8 changes: 4 additions & 4 deletions docs/QUICKSTART.html
Original file line number Diff line number Diff line change
Expand Up @@ -378,16 +378,16 @@ <h2 id="running-the-quickstart-script">Running the Quickstart Script</h2>
</ul>
<p>This will perform the following tasks necessary to set-up and start using Palisade:</p>
<ul>
<li>Download each of the Palisade repos required to run the example (<a href="https://github.com/gchq/Palisade-services/tree/develop" target="_blank">services</a> and <a href="https://github.com/gchq/Palisade-examples/tree/develop" target="_blank">examples</a>)<ul>
<li>Download each of the Palisade repos required to run the example (<a href="https://github.com/gchq/Palisade-services/tree/main" target="_blank">services</a> and <a href="https://github.com/gchq/Palisade-examples/tree/main" target="_blank">examples</a>)<ul>
<li>We will be pulling the 0.5.1 release which uses a Kafka-based streaming microservice architecture</li>
</ul>
</li>
<li>Run the Palisade local-k8s example (more details <a href="https://github.com/gchq/Palisade-examples/tree/develop/deployment-k8s/local-k8s" target="_blank">can be found here</a>), which pulls down the images from <a href="https://hub.docker.com/u/gchq" target="_blank">DockerHub</a>.</li>
<li>Run the Palisade local-k8s example (more details <a href="https://github.com/gchq/Palisade-examples/tree/main/deployment-k8s/local-k8s" target="_blank">can be found here</a>), which pulls down the images from <a href="https://hub.docker.com/u/gchq" target="_blank">DockerHub</a>.</li>
</ul>
<p>The script will have done an example run-through of Palisade, demonstrating a client with different users and purposes querying some Avro files for employee data, with some redaction and masking rules in place.
The output of this example run-through will be written to the terminal once it has completed, and if deployed successfully, you will see a success message returned.
To view the logs of the services, use Kubernetes and run <code>kubectl get logs <span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>ServiceName</span><span class="token punctuation">&gt;</span></span>-Service</code>.
More details of these rules and data structures <a href="https://github.com/gchq/Palisade-examples/tree/develop/example-library" target="_blank">can be found here</a>.</p>
More details of these rules and data structures <a href="https://github.com/gchq/Palisade-examples/tree/main/example-library" target="_blank">can be found here</a>.</p>
<p>This shutdown procedure can be automated using the <a href="https://github.com/gchq/Palisade/blob/main/quickstop.cmd" target="_blank">quickstop.cmd script</a>:</p>
<ul>
<li>On Linux/MacOS:<pre class="language-"><code>/dev/Palisade&gt; bash quickstop.cmd
Expand All @@ -397,7 +397,7 @@ <h2 id="running-the-quickstart-script">Running the Quickstart Script</h2>
</ul>
<h2 id="alternative-deployments">Alternative Deployments</h2>
<h3 id="local-jvm">Local JVM</h3>
<p>Palisade is also set-up for a JVM deployment, which <a href="https://github.com/gchq/Palisade-examples/tree/develop/deployment-jvm/local-jvm/README.md" target="_blank">is documented here</a>.<br>To run this example, you will need local installations of each service&apos;s jars, which involves cloning the remaining Palisade repositories, and using <a href="https://maven.apache.org/" target="_blank">maven</a>, installing them in the correct order, before following the local-jvm readme linked above.<br>The correct installation order for Palisade is:</p>
<p>Palisade is also set-up for a JVM deployment, which <a href="https://github.com/gchq/Palisade-examples/tree/main/deployment-jvm/local-jvm/README.md" target="_blank">is documented here</a>.<br>To run this example, you will need local installations of each service&apos;s jars, which involves cloning the remaining Palisade repositories, and using <a href="https://maven.apache.org/" target="_blank">maven</a>, installing them in the correct order, before following the local-jvm readme linked above.<br>The correct installation order for Palisade is:</p>
<ol>
<li><a href="https://github.com/gchq/Palisade-common" target="_blank">Palisade-common</a></li>
<li><a href="https://github.com/gchq/Palisade-clients" target="_blank">Palisade-clients</a></li>
Expand Down
2 changes: 1 addition & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -376,7 +376,7 @@ <h3 id="introduction">Introduction</h3>
This will enable the clients to perform queries across the datasets while still conforming to company and regulatory policies. </p>
<blockquote>
<p><img align="absmiddle" alt=":information_source:" class="emoji" src="gitbook/gitbook-plugin-advanced-emoji/emojis/information_source.png" title=":information_source:">
See the <a href="src/motivating_scenario.html">Motivating Scenario</a> for a detailed description of this example scenario, and the <a href="https://github.com/gchq/Palisade-examples/tree/develop/example-library" target="_blank">Example Library</a> package for the concrete implementation of this example used for testing.</p>
See the <a href="src/motivating_scenario.html">Motivating Scenario</a> for a detailed description of this example scenario, and the <a href="https://github.com/gchq/Palisade-examples/tree/main/example-library" target="_blank">Example Library</a> package for the concrete implementation of this example used for testing.</p>
</blockquote>
<p>Policies are set per resource and are not changed by the user or context.
However, the policies can use the information about the user and context to decide how the data needs to be sanitised for any particular query.
Expand Down
2 changes: 1 addition & 1 deletion docs/src/motivating_scenario.html
Original file line number Diff line number Diff line change
Expand Up @@ -365,7 +365,7 @@ <h1 id="motivating-scenario">Motivating Scenario</h1>
These different requests each demonstrate a different aspect of Palisade that we require.</p>
<blockquote>
<p><img align="absmiddle" alt=":information_source:" class="emoji" src="../gitbook/gitbook-plugin-advanced-emoji/emojis/information_source.png" title=":information_source:">
This scenario is implemented and demonstrated in the <a href="https://github.com/gchq/Palisade-examples/tree/develop/example-library" target="_blank">Example Library</a> package of the examples repository.</p>
This scenario is implemented and demonstrated in the <a href="https://github.com/gchq/Palisade-examples/tree/main/example-library" target="_blank">Example Library</a> package of the examples repository.</p>
</blockquote>
<h3 id="employee">Employee</h3>
<p>The <code>Employee</code> represents an element of the target dataset, the public and private details of an employee at a company.
Expand Down
2 changes: 1 addition & 1 deletion docs/src/palisade_clients.html
Original file line number Diff line number Diff line change
Expand Up @@ -397,7 +397,7 @@ <h3 id="using-the-cat-command-line-tool">Using the &apos;cat&apos; command line
Of course, this client also allows use of many existing UNIX CLI tools, such as <code>ls</code> and <code>cat</code>, but also more complex tools such as <code>sed</code> or <code>grep</code>.
This approach is not the most performant, especially when querying many thousands of resources, but should be more than enough for proof-of-concept and demonstrative purposes.</p>
<h3 id="using-the-s3-client">Using the S3 Client</h3>
<p>It is possible, via the <a href="https://github.com/gchq/Palisade-clients/tree/develop/client-s3" target="_blank">S3 Client</a> to read resources stored in AWS S3 API compliant data stores, allowing for a full AWS implementation of Palisade.
<p>It is possible, via the <a href="https://github.com/gchq/Palisade-clients/tree/main/client-s3" target="_blank">S3 Client</a> to read resources stored in AWS S3 API compliant data stores, allowing for a full AWS implementation of Palisade.
Upon deployment of Palisade using the S3 client, the relevant services are configured to expect data stored in S3, and are loaded with the relevant serialisers required to deseralise the returned LeafResource to return to the client. </p>
<h3 id="reading-a-stream-of-data-using-apache-spark">Reading a stream of data using Apache Spark</h3>
<p>You can easily adopt the S3 Client to read data from Apache Spark.<br>Given a Spark job running against AWS S3 as follows:</p>
Expand Down
2 changes: 1 addition & 1 deletion src/motivating_scenario.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ This scenario involves a number of different users requesting access to some sen
These different requests each demonstrate a different aspect of Palisade that we require.

> :information_source:
This scenario is implemented and demonstrated in the [Example Library](https://github.com/gchq/Palisade-examples/tree/develop/example-library) package of the examples repository.
This scenario is implemented and demonstrated in the [Example Library](https://github.com/gchq/Palisade-examples/tree/main/example-library) package of the examples repository.


### Employee
Expand Down
2 changes: 1 addition & 1 deletion src/palisade_clients.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ This approach is not the most performant, especially when querying many thousand


### Using the S3 Client
It is possible, via the [S3 Client](https://github.com/gchq/Palisade-clients/tree/develop/client-s3) to read resources stored in AWS S3 API compliant data stores, allowing for a full AWS implementation of Palisade.
It is possible, via the [S3 Client](https://github.com/gchq/Palisade-clients/tree/main/client-s3) to read resources stored in AWS S3 API compliant data stores, allowing for a full AWS implementation of Palisade.
Upon deployment of Palisade using the S3 client, the relevant services are configured to expect data stored in S3, and are loaded with the relevant serialisers required to deseralise the returned LeafResource to return to the client.

### Reading a stream of data using Apache Spark
Expand Down

0 comments on commit 07f9ae3

Please sign in to comment.