Skip to content
Snippets Groups Projects
Commit 3ebffcca authored by SAM CARPENTER's avatar SAM CARPENTER
Browse files

Attempt to fix most broken links / redirect a few references to external...

Attempt to fix most broken links / redirect a few references to external documentation into new internal documentation
parent 860543f6
Branches master
No related tags found
1 merge request!44Supplements Training Documentation with Additional Information
......@@ -44,7 +44,7 @@ Use [template.md](./template.md) to create new content.
* [Logging in](./docs/logging-in.md)
* [Tutorials](./docs/tutorials.md)
* [How To Guides](./docs/howto.md)
* [Training](./docs/training.md)
* [Training](./docs/training/training.md)
* [Best Practices And Recommendations](./docs/best-practices.md)
* [Shared Orgs and Sub Orgs](./docs/shared-org-vs-sub-org.md)
* [Get Help](./get-help.md)
\ No newline at end of file
* [Get Help](./get-help.md)
......@@ -17,7 +17,7 @@ The Secure Agent program is upgraded automatically by Informatica, but you are r
The DoIT Integration Platform team has experience managing secure agents.
We run our secure agent in a Docker container on Linux, hosted by Amazon Web Services (AWS).
[The Secure Agent Docker image is available here](https://git.doit.wisc.edu/interop/iics/iics_secure_agent) if you want to build and try it yourself.
[Instructions on setting up and running a Secure Agent in a similar manner are available here](../training/docker-secure-agent.md) if you want to build and try it yourself.
We use AWS Elastic Container Service (ECS) to manage the secure agent deployment environment.
By allowing ECS to run the Secure Agent container, we can make sure that the Secure Agent is always running because ECS would bring up a new instance if the current instance crashed.
......
......@@ -18,5 +18,5 @@ Access is controlled through Manifest.
See [this document](./howto.md#how-to-create-a-manifest-group-for-your-team-for-access-control) for more information.
We will also work on setting up any additional connectors, sub-orgs, or secure agent licenses, if applicable to your use case.
After getting access to IICS, you can start [training](./training.md), follow [tutorials](./tutorials.md), and start implementing your integration(s).
After getting access to IICS, you can start [training](./training/training.md), follow [tutorials](./tutorials.md), and start implementing your integration(s).
Informatica also provides documentation to get started (e.g. [getting started guide for Cloud Application Integration (CAI)](https://knowledge.informatica.com/s/article/DOC-17653?language=en_US)).
......@@ -3,9 +3,9 @@
To set up a secure agent on Linux, running in a Docker container, you will need several things:
- Access to a workstation with an Intel-based processor. This is needed to run the Secure Agent. This could be a work computer, or, in the case of someone using a Macbook with an M1 processor, this could be an Amazon WorkSpaces desktop.
- Git. This is needed to pull the necessary Secure Agent files. Official instructions on installation can be found [here](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).
- Git. This is needed to pull the necessary Secure Agent files. [Official instructions on installation can be found here](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).
- Docker. This is used to set up the container in which the Secure Agent will run.
- [Docker Compose](https://docs.docker.com/compose/). This is an additional command used to build the image which the Secure Agent runs. Instructions to install this and Docker on an AWS Workspace can be found [here](https://www.cyberciti.biz/faq/how-to-install-docker-on-amazon-linux-2/).
- [Docker Compose](https://docs.docker.com/compose/). This is an additional command used to build the image which the Secure Agent runs. [Instructions to install this and Docker on an AWS Workspace can be found here](https://www.cyberciti.biz/faq/how-to-install-docker-on-amazon-linux-2/).
- Your own IICS trial account. If you are already using the shared test or prod organizations, this tutorial is unnecessary. Use ei.secureagent.doit.wisc.edu instead. If you are using a different organization with a pre-existing Secure Agent, follow the instructions given to you when your access was provisioned.
# Setup
......@@ -36,7 +36,7 @@ To set up a secure agent on Linux, running in a Docker container, you will need
```
- The user name and password are the username and password of the IICS trial account you are doing the training on.
- The hostname is the name of the secure agent. You can choose any name here, but note that if you are doing this on AWS WorkSpaces, it will be overridden in IICS.
- The pod and region are determined by looking at the URL of your IICS account. For example, if the URL was https://usw5.dm-us.informaticacloud.com/…, the pod would be usw5 and the region would be dm-us.
- The pod and region are determined by looking at the URL of your IICS account. For example, if the URL was https<area>://usw5.dm-us.informaticacloud.com/…, the pod would be usw5 and the region would be dm-us.
4. Create shared volume and logs volume, for transferring files from the docker container to your workstation and vice-versa:
```
mkdir -p volumes/log
......
......@@ -2,7 +2,7 @@ IICS Training provides clear instructions on how to complete each component of t
#### Secure Agent on Non-Windows Machines
Assuming one is using their own trial organization while going through the tutorials, they will need to set up their own secure agent. All instructions given in IICS Training assume that you are running a secure agent from the desktop of your x86 or x64 windows machine. If one is using a different operating system this can prove troublesome, even more so if one is using a Macbook with an M1 card (or some other alternative chip format). One well-tested solution to this issue that will most likely work in any circumstance is to create a Docker Container inside of an AWS Workspace; Instructions on this process can be found [HERE](docker-secure-agent.md).
Assuming one is using their own trial organization while going through the tutorials, they will need to set up their own secure agent. All instructions given in IICS Training assume that you are running a secure agent from the desktop of your x86 or x64 windows machine. If one is using a different operating system this can prove troublesome, even more so if one is using a Macbook with an M1 card (or some other alternative chip format). One well-tested solution to this issue that will most likely work in any circumstance is to create a Docker Container inside of an AWS Workspace; [Instructions on this process can be found here](docker-secure-agent.md).
Do note that when using a machine with an M1 chip, you will be unable to successfully run the secure agent outside of AWS, even inside of a virtual machine. This has been tested with a variety of methods and is most likely a product of the nature of the program, something that cannot be worked around.
......@@ -12,7 +12,7 @@ Assuming one is not using their own trial organization, but rather the shared te
Myriad labs in IICS request that you use an Oracle database as a source for data. Setting these up can be significantly time consuming. A PostgreSQL database will work fine for this purpose if the proper data is loaded in, however.
The University hosts a test database for IICS purposes. Information on this database can be found [HERE](https://git.doit.wisc.edu/interop/iics/training-resources/-/tree/main). Several extant tables exist that are equivalents of what would be in an Oracle database. Do note that t you can use a database as a target in IICS, although this never comes up in training.
The University hosts a test database for IICS purposes. [Information on this database can be found here](https://git.doit.wisc.edu/interop/iics/training-resources/-/tree/main). Several extant tables exist that are equivalents of what would be in an Oracle database. Do note that t you can use a database as a target in IICS, although this never comes up in training.
If you are setting up the database yourself, or wish to create your own tables in the test database, do note that the given database commands are written for Oracle specifically: they will not work for Postgres, and will have to be converted to the other format.
......@@ -20,6 +20,6 @@ Do note that when using these instructions, Lab 4-1 in CAI may not work properly
#### Understanding Expressions Beyond the Basics
Most labs have you use an expression transformation, and provide you with a block of text to paste somewhere to transform data from one state to another. The labs fail to explain what this text means and how to make your own expressions, however. A reference to the functions available for use in expressions can be found [HERE](https://docs.informatica.com/integration-cloud/cloud-data-integration/current-version/function-reference/preface.html).
Most labs have you use an expression transformation, and provide you with a block of text to paste somewhere to transform data from one state to another. The labs fail to explain what this text means and how to make your own expressions, however. [A reference to the functions available for use in expressions can be found here](https://docs.informatica.com/integration-cloud/cloud-data-integration/current-version/function-reference/preface.html).
For those with experience in using programming language, an alternative can be found in the [Java Transformation](https://docs.informatica.com/integration-cloud/cloud-data-integration/current-version/transformations/java-transformation.html). Usage of the Expression Transformation is reccomended over this for most use cases however, as it has less overhead and is easier to read.
......@@ -2,7 +2,7 @@
If you weren't able to answer your question using the documentation in this repository, here are some options that are available to get help.
- Informatica provides documentation on their website. If you're looking for IICS training, please see our [training documentation](./docs/training.md).
- Informatica provides documentation on their website. If you're looking for IICS training, please see our [training documentation](./docs/training/training.md).
- [Cloud Data Integration](https://onlinehelp.informatica.com/IICS/prod/CDI/en/index.htm)
- [Cloud Application Integration ](https://onlinehelp.informatica.com/IICS/prod/CAI/en/index.htm)
- Frequently asked questions are [documented in the Informatica KB](https://search.informatica.com/).
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment