Skip to content

Commit 8af0134

Browse files
james-toussaintjames-toussaint
authored
Hotfix/7.1.2 - Readme & Changelog
Hotfix/7.1.2 - Readme & Changelog
2 parents b3454cd + 885f9dd commit 8af0134

File tree

3 files changed

+295
-33
lines changed

3 files changed

+295
-33
lines changed

‎CHANGELOG.md‎

Lines changed: 237 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,237 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
## [[7.1.2]](https://github.com/iExecBlockchainComputing/iexec-core/releases/tag/v7.1.2) 2022-11-29
6+
7+
* Update README and add CHANGELOG.
8+
9+
## [[7.1.1]](https://github.com/iExecBlockchainComputing/iexec-core/releases/tag/v7.1.1) 2022-11-28
10+
11+
* Fix build process.
12+
13+
## [[7.1.0]](https://github.com/iExecBlockchainComputing/iexec-core/releases/tag/v7.1.0) 2022-08-11
14+
15+
* Retrieve a task execution status. Logs can only be retrieved by the person who requested the execution.
16+
* Use OpenFeign client libraries.
17+
* Fix concurrency issues.
18+
* Use Spring Boot 2.6.2.
19+
* Use Java 11.0.15.
20+
21+
## [[7.0.1]](https://github.com/iExecBlockchainComputing/iexec-core/releases/tag/v7.0.1) 2022-01-05
22+
23+
* Reduce probability of giving tasks whose consensus is already reached to additional workers.
24+
* Remove useless logs.
25+
* Handle task supply and task update management based on their level of priority.
26+
* Upgrade automated build system.
27+
28+
## [[7.0.0]](https://github.com/iExecBlockchainComputing/iexec-core/releases/tag/7.0.0) 2021-12-17
29+
30+
Highly improved throughput of the iExec protocol.
31+
32+
What has changed since v6.0.0?
33+
* Fix task status deadlock. Chances to reach RUNNING task status for given states of replicates are now increased.
34+
* Fix race condition on replicate attribution.
35+
* Upgrade Jacoco/Sonarqube reporting and plugins.
36+
* Consume blockchain configuration on iexec-blockchain-adapter-api & expose its URL for iexec-worker
37+
* Upgrade artifacts publishing
38+
* Enable local import of iexec-common
39+
* Upgrade to Gradle 6.8.3
40+
* Upgrade to JUnit5
41+
* Fix concurrent upload requests.
42+
* Merge abort notifications into a single notification with custom abort cause.
43+
* Send transactions over a dedicated blockchain adapter micro-service.
44+
* Reply gracefully to the worker when a status is already reported.
45+
* Abort a TEE task when all alive workers did fail to run it.
46+
* Move task state machine to a dedicated service.
47+
* Remove useless internal task statuses belonging to the result upload request stage.
48+
* Fix Recovering for the Retryable updateReplicateStatus(..) method.
49+
* Add checks before locally upgrading to the INITIALIZED status
50+
* Remove 2-blocks waiting time before supplying a new replicate
51+
* Fix OptimisticLockingFailureException happening when 2 detectors detect the same change at the same time, leading to race updates on a same task
52+
* Reuse socket when sending multiple requests to a blockchain node.
53+
* Replay fromBlockNumber now lives in a dedicated configuration:
54+
A configuration document did store two different states. Updates on different states at the same time might lead to race conditions when saving to database. Now each state has its own document to avoid race conditions when saving.
55+
* Fix TaskRepositoy.findByChainDealIdAndTaskIndex() to return unique result.
56+
57+
## [[6.4.2]](https://github.com/iExecBlockchainComputing/iexec-core/releases/tag/6.4.2) 2021-12-14
58+
59+
* Fix task status deadlock. Chances to reach RUNNING task status for given states of replicates are now increased.
60+
61+
## [[6.4.1]](https://github.com/iExecBlockchainComputing/iexec-core/releases/tag/6.4.1) 2021-11-30
62+
63+
* Fix race condition on replicate attribution.
64+
* Upgrade Jacoco/Sonarqube reporting and plugins.
65+
66+
## [[6.4.0]](https://github.com/iExecBlockchainComputing/iexec-core/releases/tag/6.4.0) 2021-11-25
67+
68+
* Consume blockchain configuration on iexec-blockchain-adapter-api & expose its URL for iexec-worker.
69+
* Upgrade artifacts publishing.
70+
* Enable local import of iexec-common.
71+
* Upgrade to Gradle 6.8.3.
72+
* Upgrade to JUnit5.
73+
74+
## [[6.3.0]](https://github.com/iExecBlockchainComputing/iexec-core/releases/tag/6.3.0) 2021-11-16
75+
76+
* Fix concurrent upload requests.
77+
* Merge abort notifications into a single notification with custom abort cause.
78+
79+
## [[6.2.0]](https://github.com/iExecBlockchainComputing/iexec-core/releases/tag/6.2.0) 2021-11-05
80+
81+
* Send transactions over a dedicated blockchain adapter micro-service.
82+
* Reply gracefully to the worker when a status is already reported.
83+
* Abort a TEE task when all alive workers did fail to run it.
84+
* Moved task state machine to a dedicated service.
85+
* Removed useless internal task statuses belonging to the result upload request stage.
86+
87+
## [[6.1.6]](https://github.com/iExecBlockchainComputing/iexec-core/releases/tag/6.1.6) 2021-10-21
88+
89+
* Fixed Recovering for the Retryable updateReplicateStatus(..) method.
90+
91+
## [[6.1.5]](https://github.com/iExecBlockchainComputing/iexec-core/releases/tag/6.1.5) 2021-10-21
92+
93+
* Added checks before locally upgrading to the INITIALIZED status.
94+
* Removed 2-blocks waiting time before supplying a new replicate.
95+
96+
## [[6.1.4]](https://github.com/iExecBlockchainComputing/iexec-core/releases/tag/6.1.4) 2021-10-14
97+
98+
* Fixed OptimisticLockingFailureException happening when 2 detectors detect the same change at the same time, leading to race updates on a same task.
99+
100+
## [[6.1.3]](https://github.com/iExecBlockchainComputing/iexec-core/releases/tag/6.1.3) 2021-10-05
101+
102+
* Bump iexec-common dependency ([email protected]) featuring socket reuse when sending multiple requests to a blockchain node.
103+
104+
## [[6.1.2]](https://github.com/iExecBlockchainComputing/iexec-core/releases/tag/6.1.2) 2021-10-01
105+
106+
Bugfix - Replay fromBlockNumber now lives in a dedicated configuration:
107+
* A configuration document did store two different states. Updates on different states at the same time might lead to race conditions when saving to database. Now each state has its own document to avoid race conditions when saving.
108+
109+
## [[6.0.1]](https://github.com/iExecBlockchainComputing/iexec-core/releases/tag/6.0.1) 2021-09-28
110+
111+
* Fix : TaskRepositoy.findByChainDealIdAndTaskIndex() returns non-unique result
112+
113+
## [[6.0.0]](https://github.com/iExecBlockchainComputing/iexec-core/releases/tag/v6.0.0) 2021-07-29
114+
115+
What's new?
116+
* Added Prometheus actuators
117+
* Moved TEE workflow configuration to dedicated service
118+
119+
## [[5.1.1]](https://github.com/iExecBlockchainComputing/iexec-core/releases/tag/5.1.1) 2021-04-12
120+
121+
What is patched?
122+
* Updated management port and actuator endpoints.
123+
124+
## [[5.1.0]](https://github.com/iExecBlockchainComputing/iexec-core/releases/tag/5.1.0) 2021-03-26
125+
126+
What's new?
127+
128+
Fix WebSockets problem:
129+
* Enhance different task stages detection. When detecting unnotified contribute/reveal,
130+
we use the initialization block instead of the current block to lookup for the contribute/reveal metadata.
131+
* Use a dedicated TaskScheduler for STOMP WebSocket heartbeats.
132+
* Use a dedicated TaskScheduler for @Scheduled tasks.
133+
* Use a dedicated TaskExecutor for @Async tasks.
134+
* TaskService is now the entry point to update tasks.
135+
* feature/task-replay.
136+
137+
Also:
138+
* Use the deal block as a landmark for a task.
139+
* Keep the computing task list consistent.
140+
* Worker should be instructed to contribute whenever it is possible (e.g. app/data download failure).
141+
* Enhance worker lost detection.
142+
* Enhance final deadline detection for tasks.
143+
144+
## [[5.0.0]](https://github.com/iExecBlockchainComputing/iexec-core/releases/tag/5.0.0) 2020-07-22
145+
146+
What's new?
147+
* Dapp developers can browse worker computing logs over iexec-core API.
148+
* Task result link is standardized and generic. It supports Ethereum, IPFS & Dropbox "storage" providers.
149+
* Result storage feature is moved to new [iExec Result Proxy](https://github.com/iExecBlockchainComputing/iexec-result-proxy).
150+
* Full compatibility with new [iExec Secret Management Service](https://github.com/iExecBlockchainComputing/iexec-sms).
151+
* Compatibility with latest PoCo 5.1.0 smart contracts.
152+
153+
## [[4.0.1]](https://github.com/iExecBlockchainComputing/iexec-core/releases/tag/4.0.1) 2020-02-25
154+
155+
What's fixed?
156+
* More resistance to unsync Ethereum nodes.
157+
158+
## [[4.0.0]](https://github.com/iExecBlockchainComputing/iexec-core/releases/tag/4.0.0) 2019-12-13
159+
160+
What's new?
161+
* Native-token sidechain compatibility.
162+
* GPU workers support.
163+
* Log aggregation.
164+
165+
What's fixed?
166+
* Database indexes.
167+
* JWT/challenge validity duration.
168+
* Worker freed after contribution timeout.
169+
170+
## [[3.2.0]](https://github.com/iExecBlockchainComputing/iexec-core/releases/tag/3.2.0) 2019-09-17
171+
172+
What is new?
173+
* Bag Of Tasks (BoT): Bag Of Tasks Deals can now be processed by the middleware.
174+
* Use of iexec input files: Sometimes external resources are needed to run a computation without using a dataset, that is what input files are for.
175+
* Whitelisting: Now the core can define a whitelist of workers that are allowed to connect to the pool.
176+
* Https: Workers can connect to the core using https.
177+
178+
What is patched?
179+
* The project has been updated to java 11 and web3j 4.3.0.
180+
* Internal refactoring to handle replicates update better.
181+
* Limit workers that ask for replicates too often.
182+
* Update workers configuration when they disconnect/reconnect.
183+
184+
## [[3.1.0]](https://github.com/iExecBlockchainComputing/iexec-core/releases/tag/3.1.0) 2019-07-11
185+
186+
What's new?
187+
* Full end-to-end encryption inside a Trusted Execution Environment (TEE) powered by Intel(R) SGX.
188+
* Implemented the Proof-of-Contribution (PoCo) Sarmenta's formula for a greater task dispatching.
189+
190+
What's patched?
191+
* Reopen task worflow is back.
192+
* A single FAILED replicate status when a completion is impossible.
193+
* WORKER_LOST is not set for replicates which are already FAILED.
194+
* Restart when ethereum node is not available at start-up.
195+
196+
## [[3.0.1]](https://github.com/iExecBlockchainComputing/iexec-core/releases/tag/3.0.1) 2019-05-22
197+
198+
This release is a patch to fix an issue following the release of version 3.0.0.
199+
200+
When asking for a replicate, a worker sends the latest available block number from the node it is is connected to.
201+
If that node is a little bit behind the node the core is connected to, the worker will have a disadvantage compare to workers connected to more up-to-date nodes.
202+
To avoid this disadvantage, now the core waits for a few blocks before sending replicates to workers.
203+
204+
## [[3.0.0]](https://github.com/iExecBlockchainComputing/iexec-core/releases/tag/3.0.0) 2019-05-15
205+
206+
This release contains the core set of changes in the 3.0.0-alpha-X releases and some other features/fixes.
207+
In summary this version introduces:
208+
* A new architecture: the core has been completely re-architectured from the version 2.
209+
* Latest PoCo use.
210+
* Better management of transaction with the ethereum blockchain.
211+
* Failover mechanisms: in case some workers are lost or restarted when working on a specific task, internal mechanisms will redistribute the task or use as much as possible the work performed by the lost / restarted workers.
212+
* iExec End-To-End Encryption with Secret Management Service (SMS): from this version, inputs and outputs of the job can be fully encrypted using the Secret Management Service.
213+
* Decentralized oracle: If the result is needed by a smart contract, it is available directly on the blockchain.
214+
* IPFS: data can be retrieved from IPFS and public results can be published on IPFS.
215+
216+
For further information on this version, please read our documentation.
217+
218+
## [[3.0.0-alpha3]](https://github.com/iExecBlockchainComputing/iexec-core/releases/tag/3.0.0-alpha3) 2019-04-15
219+
220+
* Possibility to choose between slow and fast transactions.
221+
* Embedded IPFS node for default iexec-worker push of the results.
222+
* Better engine for supporting iexec-worker disconnections and recovery actions.
223+
* Brand new Continuous Integration and Delivery Pipeline.
224+
* Enabled SockJS over HTTP WebSocket sub-protocol to bypass some proxies.
225+
226+
## [[3.0.0-alpha2]](https://github.com/iExecBlockchainComputing/iexec-core/releases/tag/3.0.0-alpha2) 2019-02-08
227+
228+
* Some improvements have been made on the core:
229+
* Some general refactoring on the detectors.
230+
* Bug fix regarding the new PoCo version.
231+
* The core now also checks the errors on the blockchain sent by the workers.
232+
Enhancement regarding the result repo.
233+
Updated PoCo chain version 3.0.21.
234+
235+
## [[3.0.0-alpha1]](https://github.com/iExecBlockchainComputing/iexec-core/releases/tag/3.0.0-alpha1) 2019-01-25
236+
237+
* This release is the first alpha release of the version 3.0.0.

‎README.md‎

Lines changed: 57 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,67 @@
1-
# iexec-core
1+
# iExec Core Scheduler
22

33
## Overview
44

5-
The goal of the core component is to monitor the chain to check if there is any work to perform. In case there is, the core will orchestrate the work among the different workers that will participate in the computation.
5+
An iExec workerpool is orchestrated by an _iExec Core Scheduler_. The _iExec Core Scheduler_ watches on-chain deals and schedules off-chain computation among available workers.
66

7-
## Run an iexec-core
7+
## Configuration
88

9-
Gradle is used to build the project. It can be built using the gradle wrapper included in the project (so no need to have gradle installed on your machine) with the following command:
10-
```
11-
./gradlew build
12-
```
13-
They are several ways to run the project: with gradle and with docker. In both ways, there needs to be a running mongo instance as mongo is used to store data. Another pre-requisite is to have a wallet, the core component should be allowed to access it.
9+
The _iExec Core Scheduler_ is available as an OCI image on [Docker Hub](https://hub.docker.com/r/iexechub/iexec-core/tags).
1410

15-
### With gradle
16-
```
17-
./gradlew bootRun
18-
```
19-
In case you use gradle to run the project, please update the variables set in the application.yml.
11+
To run properly, the _iExec Core Scheduler_ requires:
12+
* A blockchain node. iExec smart contracts must be deployed on the blockchain network.
13+
* An Ethereum wallet to interact with smart contracts on the blockchain network. To perform on-chain transactions, the wallet must be loaded with at least 0.1 ETH and some RLC.
14+
* A _MongoDB_ instance to persist its data.
15+
* An _iExec Blockchain Adapter_ for several blockchain network interactions.
16+
* An _iExec Result Proxy_ to check if tasks results have been published.
17+
* An _iExec Secret Management Service_ (_iExec SMS_) for secret and enclave sessions management of TEE tasks.
2018

21-
### With docker
22-
```
23-
docker run -e MONGO_HOST=mongo \
24-
-e IEXEC_CORE_WALLET_PATH=path_to_encrypted_wallet \
25-
-e IEXEC_CORE_WALLET_PASSWORD=password_of_the_encrypted_wallet \
26-
-e IEXEC_PRIVATE_CHAIN_ADDRESS=http://chain_used_by_core \
27-
-e IEXEC_PUBLIC_CHAIN_ADDRESS=http://chain_used_by_workers \
28-
-e IEXEC_HUB_ADDRESS=0xaddress_of_hub_contract_onchain \
29-
-e POOL_ADDRESS=0xaddress_of_pool_contract_onchain \
30-
-e IEXEC_START_BLOCK_NUMBER=chain_start_block_number \
31-
-v #path_to_wallet:/iexec-wallet \
32-
-p 13000:13000 \
33-
iexechub/iexec-core:3.0.0-alpha1
34-
```
35-
Some other variables are settable through docker. Please check the application.yml file.
19+
You can configure the _iExec Core Scheduler_ with the following properties:
20+
21+
| Environment variable | Description | Type | Default value |
22+
| --- | --- | --- | --- |
23+
| `IEXEC_CORE_PORT` | Server port of the _iExec Core Scheduler_. | Positive integer | `13000` |
24+
| `MONGO_HOST` | _MongoDB_ server host. Cannot be set with URI. | String | `localhost` |
25+
| `MONGO_PORT` | _MongoDB_ server port. Cannot be set with URI. | Positive integer | `13002` |
26+
| `REVEAL_TIMEOUT_PERIOD` | Detector period to track reveal timeouts for tasks. | Positive integer | `120000` |
27+
| `IEXEC_ASK_REPLICATE_PERIOD` | Worker configuration, interval in milliseconds between 2 replicate requests. | Positive integer | `5000` |
28+
| `IEXEC_CORE_REQUIRED_WORKER_VERSION` | Empty value will allow any worker version. | String | |
29+
| `IEXEC_WORKERS_WHITELIST` | List of worker addresses allowed to connect to the _iExec Core Scheduler_. | String | |
30+
| `IEXEC_CORE_WALLET_PATH` | Path to the wallet of the server. | String | `./src/main/resources/wallet/encrypted-wallet_scheduler.json` |
31+
| `IEXEC_CORE_WALLET_PASSWORD` | Password to unlock the wallet of the server. | String | `whatever` |
32+
| `IEXEC_CHAIN_ID` | Chain ID of the blockchain network to connect. | Positive integer | `17` |
33+
| `IEXEC_IS_SIDECHAIN` | Define if iExec on-chain protocol is built on top of token (`false`) or native currency (`true`). | Boolean | `false` |
34+
| `IEXEC_PRIVATE_CHAIN_ADDRESS` | Private URL to connect to the blockchain node. | URL | `http://localhost:8545` |
35+
| `IEXEC_PUBLIC_CHAIN_ADDRESS` | [unused] Public URL to connect to the blockchain node. | URL | `http://localhost:8545` |
36+
| `IEXEC_HUB_ADDRESS` | Proxy contract address to interact with the iExec on-chain protocol. | String | `0xBF6B2B07e47326B7c8bfCb4A5460bef9f0Fd2002` |
37+
| `POOL_ADDRESS` | On-chain address of the workerpool managed by the current _iExec Core Scheduler_. | String | `0x365E7BABAa85eC61Dffe5b520763062e6C29dA27` |
38+
| `IEXEC_START_BLOCK_NUMBER` | Subscribe to new deal events from a specific block number. | Positive integer | `0` |
39+
| `IEXEC_GAS_PRICE_MULTIPLIER` | Transactions will be sent with `networkGasPrice * gasPriceMultiplier`. | Float | `1.0` |
40+
| `IEXEC_GAS_PRICE_CAP` | In Wei, will be used for transactions if `networkGasPrice * gasPriceMultiplier > gasPriceCap` | Integer | `22000000000` |
41+
| `IEXEC_CORE_CHAIN_ADAPTER_PROTOCOL` | _iExec Blockchain Adapter_ communication protocol. | String | `http` |
42+
| `IEXEC_CORE_CHAIN_ADAPTER_HOST` | _iExec Blockchain Adapter_ server host. | String | `blockchain-adapter` |
43+
| `IEXEC_CORE_CHAIN_ADAPTER_PORT` | _iExec Blockchain Adapter_ server port. | Positive integer | `13010` |
44+
| `IEXEC_CORE_CHAIN_ADAPTER_USERNAME` | Username to connect to the _iExec Blockchain Adapter_ server. | String | `admin` |
45+
| `IEXEC_CORE_CHAIN_ADAPTER_PASSWORD` | Password to connect to the _iExec Blockchain Adapter_ server. | String | `whatever` |
46+
| `IEXEC_RESULT_REPOSITORY_PROTOCOL` | _iExec Result Proxy_ server communication protocol. | String | `http` |
47+
| `IEXEC_RESULT_REPOSITORY_HOST` | _iExec Result Proxy_ server host. | String | `localhost` |
48+
| `IEXEC_RESULT_REPOSITORY_PORT` | _iExec Result Proxy_ server port. | Positive integer | `13200` |
49+
| `IEXEC_IPFS_HOST` | [unused] _IPFS_ node host. | String | `127.0.0.1` |
50+
| `IEXEC_IPFS_PORT` | [unused] _IPFS_ node port. | Positive integer | `5001` |
51+
| `IEXEC_SMS_PROTOCOL` | _iExec SMS_ server communication protocol. | String | `http` |
52+
| `IEXEC_SMS_HOST` | _iExec SMS_ server host. | String | `localhost` |
53+
| `IEXEC_SMS_PORT` | _iExec SMS_ server port. | Positive integer | `13300` |
54+
| `IEXEC_CORE_MANAGEMENT_PORT` | Management endpoint HTTP port (uses the same port as the application by default). Configure a different port to use management-specific SSL. | Positive integer | `13001` |
55+
| `IEXEC_CORE_MANAGEMENT_ACTUATORS` | Endpoint IDs that should be included or `*` for all. | String | `health, info` |
56+
| `IEXEC_CORE_GRAYLOG_HOST` | _Graylog_ server host. | String | `localhost` |
57+
| `IEXEC_CORE_GRAYLOG_PORT` | _Graylog_ server port. | Positive integer | `12201` |
58+
| `IEXEC_LOGS_PURGE_RATE_IN_DAYS` | Interval in days between 2 executions of the purge mechanism. | Positive integer | `1` |
59+
| `IEXEC_LOGS_AVAILABILITY_PERIOD_IN_DAYS` | Number of days to keep logs of past tasks. | Positive integer | `3` |
3660

37-
**Please note that the wallet used by the core should contain at least 0.1 ETH and some RLC to start**.
38-
Since the core will perform some transactions on the blockchain and handle some RLC, it needs both at start-up.
61+
A more exhaustive documentation is available on [the official documentation of iExec](https://docs.iex.ec/).
3962

40-
## Documentation
63+
## Build from sources
4164

42-
A more exhaustive documentation is available on [the official documentation of iExec](https://docs.iex.ec/)
65+
```
66+
./gradlew build
67+
```

‎src/main/resources/application.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ chain:
5151
hubAddress: ${IEXEC_HUB_ADDRESS:0xBF6B2B07e47326B7c8bfCb4A5460bef9f0Fd2002}
5252
poolAddress: ${POOL_ADDRESS:0x365E7BABAa85eC61Dffe5b520763062e6C29dA27}
5353
startBlockNumber: ${IEXEC_START_BLOCK_NUMBER:0}
54-
gasPriceMultiplier: ${IEXEC_GAS_PRICE_MULTIPLIER:1.0} # txs will be send with networkGasPrice*gasPriceMultiplier, 4.0 means super fast
54+
gasPriceMultiplier: ${IEXEC_GAS_PRICE_MULTIPLIER:1.0} # txs will be sent with networkGasPrice*gasPriceMultiplier, 4.0 means super fast
5555
gasPriceCap: ${IEXEC_GAS_PRICE_CAP:22000000000} #in Wei, will be used for txs if networkGasPrice*gasPriceMultiplier > gasPriceCap
5656

5757
blockchain-adapter:

0 commit comments

Comments
 (0)